diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 97a129352eb..94dd8518fa7 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -17,7 +17,7 @@ { "config": { "default": true, - "MD001": false, + "MD001": true, "MD052": false, "MD003": false, "MD013": false, @@ -30,12 +30,13 @@ "MD035": false, "MD036": false, "MD040": false, - "MD041": false, "MD045": false, "MD046": false, - "MD047": false + "MD047": true }, "ignore": [ - "node_modules/" + "node_modules/", + "target/", + "dist/" ] } diff --git a/alerter/pom.xml b/alerter/pom.xml index 8092c079730..896bbba9fb7 100644 --- a/alerter/pom.xml +++ b/alerter/pom.xml @@ -73,19 +73,19 @@ cn.afterturn easypoi-annotation - 4.3.0 + ${easy-poi.version} compile org.apache.poi poi - 4.1.1 + ${poi.version} compile org.apache.poi poi-ooxml - 4.1.1 + ${poi.version} compile diff --git a/collector/pom.xml b/collector/pom.xml index 241c999c4ca..2d93db59718 100644 --- a/collector/pom.xml +++ b/collector/pom.xml @@ -30,8 +30,6 @@ 17 ${java.version} ${java.version} - 3.2.0 - 3.3.0 @@ -89,7 +87,7 @@ com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru - 1.4.2 + ${concurrentlinkedhashmap-lru.version} com.google.guava @@ -126,12 +124,12 @@ org.apache.sshd sshd-core - 2.13.1 + ${sshd-core.version} net.i2p.crypto eddsa - 0.3.0 + ${eddsa.version} @@ -163,40 +161,40 @@ org.snmp4j snmp4j - 3.6.7 + ${snmp4j.version} org.apache.rocketmq rocketmq-tools - 4.9.4 + ${rocketmq-tools.version} dnsjava dnsjava - 3.5.2 + ${dnsjava.version} com.ecwid.consul consul-api - 1.4.5 + ${consul-api.version} com.alibaba.nacos nacos-client - 2.2.1 + ${nacos-client.version} com.vesoft client - 3.6.0 + ${vesoft-client.version} javax.servlet diff --git a/common/pom.xml b/common/pom.xml index 0aaa3497ab0..770733af86b 100644 --- a/common/pom.xml +++ b/common/pom.xml @@ -49,7 +49,7 @@ org.eclipse.persistence org.eclipse.persistence.jpa - 4.0.2 + ${eclipse-jpa.version} org.springframework.boot @@ -126,7 +126,7 @@ com.beetstra.jutf7 jutf7 - 1.0.0 + ${jutf7.version} diff --git a/home/docs/community/how-to-release.md b/home/docs/community/how-to-release.md index 3e87aa1b4b5..94c919d30f0 100644 --- a/home/docs/community/how-to-release.md +++ b/home/docs/community/how-to-release.md @@ -168,6 +168,8 @@ $ svn ci -m "add gpg key for muchunjin" ## 3. Prepare material package & release +### Build Package + #### 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 @@ -228,6 +230,8 @@ release-1.6.0-rc1 The archive package is here `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz` +### Sign package + #### 3.5 Sign binary and source packages > The `gpg -u 33545C76` `33545C76` is your gpg secret ID, see from `gpg --keyid-format SHORT --list-keys` @@ -333,7 +337,7 @@ svn commit -m "release for HertzBeat 1.6.0" ## 4. Enter the community voting stage -#### 4.1 Send a Community Vote Email +### 4.1 Send a Community Vote Email Send a voting email in the community requires at least three `+1` and no `-1`. @@ -525,9 +529,9 @@ 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 -## 4. Complete the final publishing steps +## 5. Complete the final publishing steps -#### 4.1 Migrating source and binary packages +### 5.1 Migrating source and binary packages ```shell svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0 -m "transfer packages for 1.6.0-RC1" diff --git a/home/docs/help/flink_on_yarn.md b/home/docs/help/flink_on_yarn.md index cda9abe8201..bc6bd97058c 100644 --- a/home/docs/help/flink_on_yarn.md +++ b/home/docs/help/flink_on_yarn.md @@ -2,7 +2,7 @@ > Measurement and monitoring of general metrics for Flink stream engine in Yarn running mode. -### Configuration Parameters +## Configuration Parameters | Parameter Name | Parameter Help Description | |---------------------|---------------------------------------------------------------------------------------------------------------------| diff --git a/home/docs/help/greenplum.md b/home/docs/help/greenplum.md index 761e256317d..e05539ed8c1 100644 --- a/home/docs/help/greenplum.md +++ b/home/docs/help/greenplum.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/kubernetes.md b/home/docs/help/kubernetes.md index 3cb2336e768..d7e6b657ea6 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 diff --git a/home/docs/help/status.md b/home/docs/help/status.md index ab969150e1e..dcdafbb794c 100644 --- a/home/docs/help/status.md +++ b/home/docs/help/status.md @@ -1,7 +1,4 @@ -Here is the English translation of the provided text: - --- - id: status title: Status Page sidebar_label: Status Page diff --git a/home/docs/help/vastbase.md b/home/docs/help/vastbase.md index cd0374fc777..1d595b85201 100644 --- a/home/docs/help/vastbase.md +++ b/home/docs/help/vastbase.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/start/quickstart.md b/home/docs/start/quickstart.md index 5c0a9868252..0911ef7a32c 100644 --- a/home/docs/start/quickstart.md +++ b/home/docs/start/quickstart.md @@ -8,7 +8,7 @@ sidebar_label: Quick Start - If you wish to deploy Apache HertzBeat (incubating) locally, please refer to the following Deployment Documentation for instructions. -### 🍞 Install HertzBeat +#### 🍞 Install HertzBeat > Apache HertzBeat (incubating) supports installation through source code, docker or package, cpu support X86/ARM64. diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.4.x.json b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.4.x.json deleted file mode 100644 index 288ef4a4d32..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.4.x.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "version.label": { - "message": "v1.4.x", - "description": "The label for version v1.4.x" - }, - "sidebar.docs.category.quickstart": { - "message": "quickstart", - "description": "The label for category quickstart in sidebar docs" - }, - "sidebar.docs.category.custom": { - "message": "custom", - "description": "The label for category custom in sidebar docs" - }, - "sidebar.docs.category.http": { - "message": "http", - "description": "The label for category http in sidebar docs" - }, - "sidebar.docs.category.jdbc": { - "message": "jdbc", - "description": "The label for category jdbc in sidebar docs" - }, - "sidebar.docs.category.ssh": { - "message": "ssh", - "description": "The label for category ssh in sidebar docs" - }, - "sidebar.docs.category.jmx": { - "message": "jmx", - "description": "The label for category jmx in sidebar docs" - }, - "sidebar.docs.category.snmp": { - "message": "snmp", - "description": "The label for category snmp in sidebar docs" - }, - "sidebar.docs.category.push": { - "message": "push", - "description": "The label for category push in sidebar docs" - }, - "sidebar.docs.category.help": { - "message": "help", - "description": "The label for category help in sidebar docs" - }, - "sidebar.docs.category.service": { - "message": "service", - "description": "The label for category service in sidebar docs" - }, - "sidebar.docs.category.program": { - "message": "program", - "description": "The label for category program in sidebar docs" - }, - "sidebar.docs.category.database": { - "message": "database", - "description": "The label for category database in sidebar docs" - }, - "sidebar.docs.category.cache": { - "message": "cache", - "description": "The label for category cache in sidebar docs" - }, - "sidebar.docs.category.os": { - "message": "os", - "description": "The label for category os in sidebar docs" - }, - "sidebar.docs.category.mid": { - "message": "mid", - "description": "The label for category mid in sidebar docs" - }, - "sidebar.docs.category.bigdata": { - "message": "bigdata", - "description": "The label for category bigdata in sidebar docs" - }, - "sidebar.docs.category.webserver": { - "message": "webserver", - "description": "The label for category webserver in sidebar docs" - }, - "sidebar.docs.category.cloud-native": { - "message": "cloud-native", - "description": "The label for category cloud-native in sidebar docs" - }, - "sidebar.docs.category.threshold": { - "message": "threshold", - "description": "The label for category threshold in sidebar docs" - }, - "sidebar.docs.category.notice": { - "message": "notice", - "description": "The label for category notice in sidebar docs" - }, - "sidebar.docs.category.Others": { - "message": "Others", - "description": "The label for category Others in sidebar docs" - } -} diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-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 1d7bf0a0042..0429d684ddd 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 @@ -70,4 +70,4 @@ Bugfix. Online . -Have Fun \ No newline at end of file +Have Fun diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-11-hertzbeat-v1.6.0-update.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-11-hertzbeat-v1.6.0-update.md index 2f612c42c28..b75648284ff 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-11-hertzbeat-v1.6.0-update.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-11-hertzbeat-v1.6.0-update.md @@ -1,10 +1,10 @@ # HertzBeat 1.6.0 升级指南 -### 注意：该指南适用于1.5.0向1.6.0版本升级 +## 注意：该指南适用于1.5.0向1.6.0版本升级 -### 如果你使用更老的版本，建议使用导出功能重新安装，或先升级到1.5.0再按本指南升级到1.6.0 +## 如果你使用更老的版本，建议使用导出功能重新安装，或先升级到1.5.0再按本指南升级到1.6.0 -### 二进制安装包升级 +## 二进制安装包升级 1. 升级Java环境 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 29b1dac509b..5402bc696aa 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 @@ -168,6 +168,8 @@ $ svn ci -m "add gpg key for muchunjin" ## 3. 准备物料 & 发布 +### 准备发布物料 + #### 3.1 基于 master 分支，创建一个名为 release-${release_version}-rcx 的分支，例如 release-1.6.0-rc1。并基于 release-1.6.0-rc1 分支创建一个名为 v1.6.0-rc1 的标签，并将此标签设置为预发布 ```shell @@ -228,6 +230,8 @@ release-1.6.0-rc1 生成的代码归档文件在 `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz` +### 签名发布物料 + #### 3.5 对二进制和源码包进行签名 将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。 @@ -335,7 +339,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" ## 4. 进入社区投票阶段 -#### 4.1 发送社区投票邮件 +### 4.1 发送社区投票邮件 发送社区投票邮件需要至少三个`+1`，且无`-1`。 @@ -426,7 +430,7 @@ ChunJin Mu 邮件内容中的一项是`Vote thread`，在 查看获取 -#### 3.2 发送孵化社区投票邮件 +### 3.2 发送孵化社区投票邮件 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。 @@ -529,13 +533,13 @@ ChunJin Mu ## 4. 完成最终发布步骤 -#### 4.1 迁移源代码和二进制包 +### 4.1 迁移源代码和二进制包 ```shell svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0 -m "transfer packages for 1.6.0-RC1" ``` -#### 4.2 添加新版本下载地址到官网 +### 4.2 添加新版本下载地址到官网 @@ -544,7 +548,7 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http > 需要注意的是，下载链接可能需要一个小时后才会生效，请注意。 -#### 4.3 Github 生成 Release +### 4.3 Github 生成 Release 基于 release-1.6.0-rc1 分支修改创建一个名为 v1.6.0 的标签，并将此标签设置为 latest release。 @@ -571,7 +575,7 @@ release note: xxx 然后将 release-1.6.0-rc1 分支重命名 为 release-1.6.0。 -#### 4.4 发送新版本公告邮件 +### 4.4 发送新版本公告邮件 > `Send to`:
> `cc`:
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 386ec0e91e1..e012e347c20 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 @@ -5,7 +5,7 @@ sidebar_label: DNS服务器 keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] --- -# 监控：DNS服务器 +## 监控：DNS服务器 > 收集和监控DNS的常规性能指标。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/greenplum.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/greenplum.md index 2d971964799..e1094830096 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/greenplum.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/greenplum.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, GreenPlum 数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - 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 4f0363f621d..cc4c7254afe 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 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 a160f2501e4..0806232cee5 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 @@ -7,7 +7,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito NTP监控的中文文档如下： -# NTP监控 +## NTP监控 > 收集和监控NTP的常规性能指标。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/vastbase.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/vastbase.md index f8e2d76aa55..1a5b020ff8d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/vastbase.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/vastbase.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, Vastbase 数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/update-1.6.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/update-1.6.0.md index 8c8becc369d..7b1a30c7f06 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/update-1.6.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/update-1.6.0.md @@ -4,7 +4,7 @@ title: 如何升级到1.6.0 sidebar_label: 1.6.0升级指南 --- -# HertzBeat 1.6.0 升级指南 +## HertzBeat 1.6.0 升级指南 ### 注意：该指南适用于1.5.0向1.6.0版本升级 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x.json b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x.json deleted file mode 100644 index 53a82b3fbdb..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "version.label": { - "message": "v1.4.x", - "description": "The label for version v1.4.x" - }, - "sidebar.docs.category.quickstart": { - "message": "quickstart", - "description": "The label for category quickstart in sidebar docs" - }, - "sidebar.docs.category.custom": { - "message": "custom", - "description": "The label for category custom in sidebar docs" - }, - "sidebar.docs.category.http": { - "message": "http", - "description": "The label for category http in sidebar docs" - }, - "sidebar.docs.category.jdbc": { - "message": "jdbc", - "description": "The label for category jdbc in sidebar docs" - }, - "sidebar.docs.category.ssh": { - "message": "ssh", - "description": "The label for category ssh in sidebar docs" - }, - "sidebar.docs.category.jmx": { - "message": "jmx", - "description": "The label for category jmx in sidebar docs" - }, - "sidebar.docs.category.snmp": { - "message": "snmp", - "description": "The label for category snmp in sidebar docs" - }, - "sidebar.docs.category.push": { - "message": "push", - "description": "The label for category push in sidebar docs" - }, - "sidebar.docs.category.help": { - "message": "help", - "description": "The label for category help in sidebar docs" - }, - "sidebar.docs.category.service": { - "message": "service", - "description": "The label for category service in sidebar docs" - }, - "sidebar.docs.category.program": { - "message": "program", - "description": "The label for category program in sidebar docs" - }, - "sidebar.docs.category.database": { - "message": "database", - "description": "The label for category database in sidebar docs" - }, - "sidebar.docs.category.cache": { - "message": "cache", - "description": "The label for category cache in sidebar docs" - }, - "sidebar.docs.category.os": { - "message": "os", - "description": "The label for category os in sidebar docs" - }, - "sidebar.docs.category.mid": { - "message": "mid", - "description": "The label for category mid in sidebar docs" - }, - "sidebar.docs.category.bigdata": { - "message": "bigdata", - "description": "The label for category bigdata in sidebar docs" - }, - "sidebar.docs.category.webserver": { - "message": "webserver", - "description": "The label for category webserver in sidebar docs" - }, - "sidebar.docs.category.cloud-native": { - "message": "cloud-native", - "description": "The label for category cloud-native in sidebar docs" - }, - "sidebar.docs.category.threshold": { - "message": "threshold", - "description": "The label for category threshold in sidebar docs" - }, - "sidebar.docs.category.notice": { - "message": "notice", - "description": "The label for category notice in sidebar docs" - }, - "sidebar.docs.category.Others": { - "message": "Others", - "description": "The label for category Others in sidebar docs" - }, - "sidebar.docs.link.Cloud Service": { - "message": "Cloud Service", - "description": "The label for link Cloud Service in sidebar docs, linking to https://console.tancloud.cn" - }, - "sidebar.docs.link.Install via HuaweiCloud": { - "message": "Install via HuaweiCloud", - "description": "The label for link Install via HuaweiCloud in sidebar docs, linking to https://marketplace.huaweicloud.com/contents/0477015c-ad63-4522-a308-816861769f0a#productid=OFFI863735781612109824" - }, - "sidebar.docs.link.Install via Helm": { - "message": "Install via Helm", - "description": "The label for link Install via Helm in sidebar docs, linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat" - } -} 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 deleted file mode 100644 index c0acbf1ea87..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -id: extend-http-default -title: HTTP协议系统默认解析方式 -sidebar_label: 系统默认解析方式 ---- - -> HTTP接口调用获取响应数据后，用HertzBeat默认的解析方式去解析响应数据。 - -**此需接口响应数据结构符合HertzBeat指定的数据结构规则** - -### HertzBeat数据格式规范 - -注意⚠️ 响应数据为JSON - -单层格式：key-value - -```json -{ - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" -} -``` - -多层格式：数组里面套key-value - -```json -[ - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - }, - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - } -] -``` - -样例： -查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 -若只有一台虚拟机，其单层格式为: - -```json -{ - "hostname": "linux-1", - "core": 1, - "usage": 78.0, - "allTime": 200, - "runningTime": 100 -} -``` - -若有多台虚拟机，其多层格式为: - -```json -[ - { - "hostname": "linux-1", - "core": 1, - "usage": 78.0, - "allTime": 200, - "runningTime": 100 - }, - { - "hostname": "linux-2", - "core": 3, - "usage": 78.0, - "allTime": 566, - "runningTime": 34 - }, - { - "hostname": "linux-3", - "core": 4, - "usage": 38.0, - "allTime": 500, - "runningTime": 20 - } -] -``` - -**对应的监控模版YML可以配置为如下** - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 80 - # 参数输入框提示信息 - placeholder: '请输入端口' -# collect metrics config list -# 采集指标配置列表 -metrics: - # First monitoring metric group cpu - # Note: The built-in monitoring metrics include (responseTime - response time) - - name: cpu - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: hostname - type: 1 - label: true - - field: usage - type: 0 - unit: '%' - - field: core - type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /metrics/cpu - # 请求方式 GET POST PUT DELETE PATCH - method: GET - # 是否启用ssl/tls,即是http还是https,默认false - ssl: false - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # 这里使用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 deleted file mode 100644 index 9317fdbfc21..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -id: extend-http-example-hertzbeat -title: 教程一:适配一款基于HTTP协议的监控类型 -sidebar_label: 教程一:适配一款HTTP协议监控 ---- - -通过此教程我们一步一步描述如何在hertzbeat监控系统下新增适配一款基于http协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 - -### HTTP协议解析通用响应结构体，获取指标数据 - -> 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - -``` -{ - "code": 200, - "msg": "success", - "data": {} -} - -``` - -如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API -`http://localhost:1157/api/summary`, 其响应数据为: - -``` -{ - "msg": null, - "code": 0, - "data": { - "apps": [ - { - "category": "service", - "app": "jvm", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - }, - { - "category": "service", - "app": "website", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - } - ] - } -} -``` - -**我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - -### 新增自定义监控模版YML - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 - -样例：自定义一个名称为`hertzbeat`的自定义监控类型，其使用HTTP协议采集指标数据。 - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: hertzbeat -name: - zh-CN: HertzBeat监控系统 - en-US: HertzBeat Monitor -params: - - field: host - name: - zh-CN: 主机Host - en-US: Host - type: host - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 1157 - - field: ssl - name: - zh-CN: 启用HTTPS - en-US: HTTPS - type: boolean - required: true - - field: timeout - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - type: number - required: false - hide: true - - field: authType - name: - zh-CN: 认证方式 - en-US: Auth Type - type: radio - required: false - hide: true - options: - - label: Basic Auth - value: Basic Auth - - label: Digest Auth - value: Digest Auth - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: false - hide: true - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - hide: true -# collect metrics config list -# 采集指标配置列表 -metrics: - # metrics - summary - # 监控指标 - summary - - name: summary - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: responseTime - type: 0 - unit: ms - - field: app - type: 1 - label: true - - field: category - type: 1 - - field: status - type: 0 - - field: size - type: 0 - - field: availableSize - type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk, 我们这里使用HTTP协议 - protocol: http -# 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径，我们这里不需要输入传参，写死为 /api/summary - url: /api/summary - timeout: ^_^timeout^_^ - # 请求方式 GET POST PUT DELETE PATCH，写死为 - method: GET - # 是否启用ssl/tls,即是http还是https,默认false - ssl: ^_^ssl^_^ - # 认证 - authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token - type: ^_^authType^_^ - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - digestAuthUsername: ^_^username^_^ - digestAuthPassword: ^_^password^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控，我们这里使用jsonpath来解析响应数据 - parseType: jsonPath - parseScript: '$.data.apps.*' - -``` - -**新增完毕，现在我们重启hertzbeat系统。我们可以看到系统页面已经多了一个`hertzbeat`监控类型了。** - -![](/img/docs/advanced/extend-http-example-1.png) - -### 系统页面添加对`hertzbeat`监控类型的监控 - -> 我们点击新增 `HertzBeat监控系统`，配置监控IP，端口，采集周期，高级设置里的账户密码等, 点击确定添加监控。 - -![](/img/docs/advanced/extend-http-example-2.png) - -![](/img/docs/advanced/extend-http-example-3.png) - -> 过一定时间(取决于采集周期)我们就可以在监控详情看到具体的指标数据和历史图表啦！ - -![](/img/docs/advanced/extend-http-example-4.png) - -### 设置阈值告警通知 - -> 接下来我们就可以正常的设置阈值，告警触发后可以在告警中心查看，也可以新增接收人，设置告警通知等，Have Fun!!! - ----- - -#### 完 - -HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ - -如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ - -**github: ** - -**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 deleted file mode 100644 index bbcaa5299d0..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -id: extend-http-example-token -title: 教程二:基于HTTP协议获取TOKEN指标值，给后续采集认证使用 -sidebar_label: 教程二:获取TOKEN后续认证使用 ---- - -通过此教程我们一步一步描述如何在教程一的基础上改造，新增一个监控指标，先调用认证接口获取TOKEN后，使用TOKEN作为参数供后面的监控指标采集认证使用。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 - -### 请求流程 - -【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 - -> 这里我们依然用教程一的hertzbeat监控举例！hertzbeat后台接口不仅仅支持教程一使用的basic直接账户密码认证，也支持token认证。 - -**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: - -```json -{ - "credential": "hertzbeat", - "identifier": "admin" -} -``` - -**响应结构数据如下**: - -```json -{ - "data": { - "token": "xxxx", - "refreshToken": "xxxx" - }, - "msg": null, - "code": 0 -} -``` - -### 新增自定义监控类型`hertzbeat_token` - -1. 自定义监控类型需新增配置监控模版YML,我们直接复用教程一的 `hertzbeat` 监控类型，在其基础上修改 - -监控配置定义文件是用来定义采集类型是啥，需要用哪种协议采集方式，采集的指标是啥，协议的配置参数等。 -我们直接复用 app-hertzbeat.yml 里面的定义内容,修改为我们当前的监控类型`hertzbeat_auth`配置参数, 比如 `app, category等`。 - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: hertzbeat_token -name: - zh-CN: HertzBeat监控(Token) - en-US: HertzBeat Monitor(Token) -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 1157 - # 参数输入框提示信息 - placeholder: '请输入端口' - - field: ssl - name: - zh-CN: 启动SSL - en-US: SSL - # 当type为boolean时,前端用switch展示开关 - type: boolean - required: false - - field: contentType - name: - zh-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - zh-CN: 请求BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# 采集指标配置列表 todo 下方配置 -metrics: ...... - -``` - -### 定义监控指标`auth`登录请求获取`token` - -1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. - -```yaml - -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: hertzbeat_token -name: - zh-CN: HertzBeat监控(Token) - en-US: HertzBeat Monitor(Token) -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 1157 - # 参数输入框提示信息 - placeholder: '请输入端口' - - field: ssl - name: - zh-CN: 启动SSL - en-US: SSL - # 当type为boolean时,前端用switch展示开关 - type: boolean - required: false - - field: contentType - name: - zh-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - zh-CN: 请求BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# 采集指标配置列表 -metrics: - # 第一个监控指标 auth - # 注意：内置监控指标有 (responseTime - 响应时间) - - name: auth - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: token - type: 1 - - field: refreshToken - type: 1 - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /api/account/auth/form - # 请求方式 GET POST PUT DELETE PATCH - method: POST - # 是否启用ssl/tls,即是http还是https,默认false - ssl: ^_^ssl^_^ - payload: ^_^payload^_^ - # 请求头内容 - headers: - content-type: ^_^contentType^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - parseType: jsonPath - parseScript: '$.data' - -``` - -**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下:** - -```json -{ - "credential": "hertzbeat", - "identifier": "admin" -} -``` - -![](/img/docs/advanced/extend-http-example-5.png) - -**新增成功后我们就可以在详情页面看到我们采集的 `token`, `refreshToken`指标数据。** - -![](/img/docs/advanced/extend-http-example-6.png) - -![](/img/docs/advanced/extend-http-example-7.png) - -### 将`token`作为变量参数给后面的监控指标采集使用 - -**在`app-hertzbeat_token.yml`新增一个监控指标定义 `summary` 同教程一中的`summary`相同, 设置采集优先级为1** -**设置此监控指标的HTTP协议配置中认证方式为 `Bearer Token` 将上一个监控指标`auth`采集的指标`token`作为参数给其赋值，使用`^o^`作为内部替换符标识，即`^o^token^o^`。如下:** - -```yaml - - name: summary -# 当protocol为http协议时具体的采集配置 - http: - # 认证 - authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token - type: Bearer Token - bearerTokenToken: ^o^token^o^ -``` - -**最终`app-hertzbeat_token.yml`定义如下:** - -```yaml - -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: hertzbeat_token -name: - zh-CN: HertzBeat监控(Token) - en-US: HertzBeat Monitor(Token) -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 1157 - # 参数输入框提示信息 - placeholder: '请输入端口' - - field: ssl - name: - zh-CN: 启动SSL - en-US: SSL - # 当type为boolean时,前端用switch展示开关 - type: boolean - required: false - - field: contentType - name: - zh-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - zh-CN: 请求BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# 采集指标配置列表 -metrics: -# 第一个监控指标 cpu -# 注意：内置监控指标有 (responseTime - 响应时间) - - name: auth - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: token - type: 1 - - field: refreshToken - type: 1 - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /api/account/auth/form - # 请求方式 GET POST PUT DELETE PATCH - method: POST - # 是否启用ssl/tls,即是http还是https,默认false - ssl: ^_^ssl^_^ - payload: ^_^payload^_^ - # 请求头内容 - headers: - content-type: ^_^contentType^_^ - ^_^headers^_^: ^_^headers^_^ - # 请求参数内容 - params: - ^_^params^_^: ^_^params^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - parseType: jsonPath - parseScript: '$.data' - - - - name: summary - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 1 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: category - type: 1 - - field: app - type: 1 - - field: size - type: 0 - - field: status - type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /api/summary - # 请求方式 GET POST PUT DELETE PATCH - method: GET - # 是否启用ssl/tls,即是http还是https,默认false - ssl: ^_^ssl^_^ - # 认证 - authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token - type: Bearer Token - bearerTokenToken: ^o^token^o^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - parseType: jsonPath - parseScript: '$.data.apps.*' - -``` - -**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** - -![](/img/docs/advanced/extend-http-example-8.png) - -![](/img/docs/advanced/extend-http-example-9.png) - -### 设置阈值告警通知 - -> 接下来我们就可以正常设置阈值，告警触发后可以在告警中心查看，也可以新增接收人，设置告警通知等，Have Fun!!! - ----- - -#### 完 - -HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ - -如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ - -**github: ** - -**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 deleted file mode 100644 index 5ce2aad2738..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -id: extend-http-jsonpath -title: HTTP协议JsonPath解析方式 -sidebar_label: JsonPath解析方式 ---- - -> HTTP接口调用获取响应数据后，用JsonPath脚本解析的解析方式去解析响应数据。 - -注意⚠️ 响应数据为JSON格式 - -**使用JsonPath脚本将响应数据解析成符合HertzBeat指定的数据结构规则的数据** - -#### JsonPath操作符 - -[JSONPath在线验证](https://www.jsonpath.cn) - -| JSONPATH | 帮助描述 | -|------------------|-----------------------------------| -| $ | 根对象或元素 | -| @ | 当前对象或元素 | -| . or [] | 子元素操作符 | -| .. | 递归匹配所有子元素 | -| * | 通配符. 匹配所有对象或元素. | -| [] | 下标运算符，JsonPath索引从0开始 | -| [,] | 连接运算符，将多个结果拼成数组返回，JSONPath允许使用别名. | -| [start:end:step] | 数组切片运算符 | -| ?() | 过滤器（脚本）表达式. | -| () | 脚本表达式. | - -#### HertzBeat数据格式规范 - -单层格式：key-value - -```json -{ - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" -} -``` - -多层格式：数组里面套key-value - -```json -[ - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - }, - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - } -] -``` - -#### 样例 - -查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 -接口返回的原始数据如下： - -```json -{ - "firstName": "John", - "lastName" : "doe", - "age" : 26, - "address" : { - "streetAddress": "naist street", - "city" : "Nara", - "postalCode" : "630-0192" - }, - "number": [ - { - "type": "core", - "num": 3343 - }, - { - "type": "home", - "num": 4543 - } - ] -} -``` - -我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： - -```json -[ - { - "type": "core", - "num": 3343 - }, - { - "type": "home", - "num": 4543 - } -] -``` - -此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 - -**对应的监控模版YML可以配置为如下** - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 80 - # 参数输入框提示信息 - placeholder: '请输入端口' -# collect metrics config list -# 采集指标配置列表 -metrics: - # metrics - cpu - # 监控指标 - cpu - - name: cpu - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: type - type: 1 - label: true - - field: num - type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /metrics/person - # 请求方式 GET POST PUT DELETE PATCH - method: GET - # 是否启用ssl/tls,即是http还是https,默认false - ssl: false - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # 这里使用jsonPath解析 - 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 deleted file mode 100644 index 467921638da..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -id: extend-http -title: HTTP协议自定义监控 -sidebar_label: HTTP协议自定义监控 ---- - -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 - -### HTTP协议采集流程 - -【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 - -由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 -HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 - -**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) -**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) - -### 自定义步骤 - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 - -### 监控模版YML - -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 - -样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example_http -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 80 - # 参数输入框提示信息 - placeholder: '请输入端口' - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - # 当type为text时,用limit表示字符串限制大小 - limit: 20 - required: false - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - - field: ssl - name: - zh-CN: 启动SSL - en-US: Enable SSL - # 当type为boolean时,前端用switch展示开关 - type: boolean - required: false - - field: method - name: - zh-CN: 请求方式 - en-US: Method - type: radio - required: true - # 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2} - options: - - label: GET请求 - value: GET - - label: POST请求 - value: POST - - label: PUT请求 - value: PUT - - label: DELETE请求 - value: DELETE -# 采集指标配置列表 -metrics: -# 第一个监控指标 cpu -# 注意：内置监控指标有 (responseTime - 响应时间) - - name: cpu - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: hostname - type: 1 - label: true - - field: usage - type: 0 - unit: '%' - - field: cores - type: 0 - - field: waitTime - type: 0 - unit: s -# (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 - aliasFields: - - hostname - - core1 - - core2 - - usage - - allTime - - runningTime -# (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - hostname=hostname - - cores=core1+core2 - - usage=usage - - waitTime=allTime-runningTime -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /metrics/cpu - # 请求方式 GET POST PUT DELETE PATCH - method: GET - # 是否启用ssl/tls,即是http还是https,默认false - ssl: false - # 请求头内容 - headers: - apiVersion: v1 - # 请求参数内容 - params: - param1: param1 - param2: param2 - # 认证 - authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # todo xmlPath-xmlPath脚本,prometheus-Prometheus数据规则 - parseType: jsonPath - parseScript: '$' - - - name: memory - priority: 1 - fields: - - field: hostname - type: 1 - label: true - - field: total - type: 0 - unit: kb - - field: usage - type: 0 - unit: '%' - - field: speed - type: 0 - protocol: http - http: - host: ^_^host^_^ - port: ^_^port^_^ - url: /metrics/memory - method: GET - headers: - apiVersion: v1 - params: - param1: param1 - param2: param2 - authorization: - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - parseType: default -``` diff --git a/home/i18n/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 deleted file mode 100644 index 9dd3e547b5b..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -id: extend-jdbc -title: JDBC协议自定义监控 -sidebar_label: JDBC协议自定义监控 ---- - -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 -> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 - -### JDBC协议采集流程 - -【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 - -由流程可见，我们自定义一个JDBC协议的监控类型，需要配置JDBC请求参数，配置获取哪些指标，配置查询SQL语句。 - -### 数据解析方式 - -SQL查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有三种：oneRow, multiRow, columns - -#### **oneRow** - -> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 - -例如： -查询的指标字段为：one tow three four -查询SQL：select one, tow, three, four from book limit 1; -这里指标字段就能和响应数据一一映射为一行采集数据。 - -#### **multiRow** - -> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 - -例如： -查询的指标字段为：one tow three four -查询SQL：select one, tow, three, four from book; -这里指标字段就能和响应数据一一映射为多行采集数据。 - -#### **columns** - -> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 - -例如： -查询字段：one tow three four -查询SQL：select key, value from book; -SQL响应数据： - -| key | value | -|-------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | - -这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 - -### 自定义步骤 - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -下面详细介绍下文件的配置用法，请注意看使用注释。 - -### 监控模版YML - -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 - -样例：自定义一个名称为example_sql的自定义监控类型，其使用JDBC协议采集指标数据。 - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: db -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example_sql -name: - zh-CN: 模拟MYSQL应用类型 - en-US: MYSQL EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host -params: - - field: host - name: - zh-CN: 主机Host - en-US: Host - type: host - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 80 - placeholder: '请输入端口' - - field: database - name: - zh-CN: 数据库名称 - en-US: Database - type: text - required: false - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: false - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - - field: url - name: - zh-CN: Url - en-US: Url - type: text - required: false -# 采集指标配置列表 -metrics: - - name: basic - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: version - type: 1 - label: true - - field: port - type: 1 - - field: datadir - type: 1 - - field: max_connections - type: 0 - # (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 - aliasFields: - - version - - version_compile_os - - version_compile_machine - - port - - datadir - - max_connections - # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 - # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - port=port - - datadir=datadir - - max_connections=max_connections - - version=version+"_"+version_compile_os+"_"+version_compile_machine - protocol: jdbc - jdbc: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - platform: mysql - username: ^_^username^_^ - password: ^_^password^_^ - database: ^_^database^_^ - # SQL查询方式： oneRow, multiRow, columns - queryType: columns - # sql - sql: show global variables where Variable_name like 'version%' or Variable_name = 'max_connections' or Variable_name = 'datadir' or Variable_name = 'port'; - url: ^_^url^_^ - - - name: status - priority: 1 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: threads_created - type: 0 - - field: threads_connected - type: 0 - - field: threads_cached - type: 0 - - field: threads_running - type: 0 - # (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 - aliasFields: - - threads_created - - threads_connected - - threads_cached - - threads_running - # (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 - # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - threads_created=threads_created - - threads_connected=threads_connected - - threads_cached=threads_cached - - threads_running=threads_running - protocol: jdbc - jdbc: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - platform: mysql - username: ^_^username^_^ - password: ^_^password^_^ - database: ^_^database^_^ - # SQL查询方式： oneRow, multiRow, columns - queryType: columns - # sql - sql: show global status where Variable_name like 'thread%' or Variable_name = 'com_commit' or Variable_name = 'com_rollback' or Variable_name = 'questions' or Variable_name = 'uptime'; - url: ^_^url^_^ - - - name: innodb - priority: 2 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: innodb_data_reads - type: 0 - unit: 次数 - - field: innodb_data_writes - type: 0 - unit: 次数 - - field: innodb_data_read - type: 0 - unit: kb - - field: innodb_data_written - type: 0 - unit: kb - protocol: jdbc - jdbc: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - platform: mysql - username: ^_^username^_^ - password: ^_^password^_^ - database: ^_^database^_^ - # SQL查询方式： oneRow, multiRow, columns - queryType: columns - # sql - 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 deleted file mode 100644 index 0e7694f76ce..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -id: extend-jmx -title: JMX协议自定义监控 -sidebar_label: JMX协议自定义监控 ---- - -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 -> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 - -### JMX协议采集流程 - -【**对端JAVA应用暴露JMX服务**】->【**HertzBeat直连对端JMX服务**】->【**获取配置的 Mbean Object 数据**】->【**指标数据提取**】 - -由流程可见，我们自定义一个JMX协议的监控类型，需要配置JMX请求参数，配置获取哪些指标，配置查询Object信息。 - -### 数据解析方式 - -通过配置监控模版YML的指标`field`, `aliasFields`, `jmx` 协议的 `objectName` 来和对端系统暴露的 `Mbean`对象信息映射解析。 - -### 自定义步骤 - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -下面详细介绍下监控模版的配置用法，请注意看使用注释。 - -### 监控模版YML - -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 - -样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: service -# The monitoring type eg: linux windows tomcat mysql aws... -# 监控类型 eg: linux windows tomcat mysql aws... -app: example_jvm -# The monitoring i18n name -# 监控类型国际化名称 -name: - zh-CN: 自定义JVM虚拟机 - en-US: CUSTOM JVM -# Input params define for monitoring(render web ui by the definition) -# 监控所需输入参数定义(根据定义渲染页面UI) -params: - # field-param field key - # field-字段名称标识符 - - field: host - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # required-true or false - # 是否是必输项 true-必填 false-可选 - required: true - # field-param field key - # field-变量字段标识符 - - field: port - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: number - # when type is number, range is required - # 当type为number时,用range表示范围 - range: '[0,65535]' - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # default value - # 端口默认值 - defaultValue: 9999 - # field-param field key - # field-变量字段标识符 - - field: url - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: JMX URL - en-US: JMX URL - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: text - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: false - # hide param-true or false - # 是否隐藏字段 true or false - hide: true - # param field input placeholder - # 参数输入框提示信息 - placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi' - # field-param field key - # field-变量字段标识符 - - field: username - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 用户名 - en-US: Username - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: text - # when type is text, use limit to limit string length - # 当type为text时,用limit表示字符串限制大小 - limit: 20 - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: false - # hide param-true or false - # 是否隐藏字段 true or false - hide: true - # field-param field key - # field-变量字段标识符 - - field: password - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 密码 - en-US: Password - # type-param field type(most mapping the html input tag) - # type-字段类型,样式(大部分映射input标签type属性) - type: password - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: false - # hide param-true or false - # 是否隐藏字段 true or false - hide: true -# collect metrics config list -# 采集指标配置列表 -metrics: - # metrics - basic - # 监控指标 - basic - - name: basic - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # collect metrics content - # 具体监控指标列表 - fields: - # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label - # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 - - field: VmName - type: 1 - - field: VmVendor - type: 1 - - field: VmVersion - type: 1 - - field: Uptime - type: 0 - unit: ms - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk - # 用于监控的协议，例: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: jmx - # the config content when protocol is jmx - jmx: - # host: ipv4 ipv6 domain - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # port - # 端口 - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - # jmx mbean object name - # jmx mbean 对象名称 - objectName: java.lang:type=Runtime - url: ^_^url^_^ - - - name: memory_pool - priority: 1 - fields: - - field: name - type: 1 - label: true - - field: committed - type: 0 - unit: MB - - field: init - type: 0 - unit: MB - - field: max - type: 0 - unit: MB - - field: used - type: 0 - unit: MB - units: - - committed=B->MB - - init=B->MB - - max=B->MB - - used=B->MB - # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field - # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换 - aliasFields: - - Name - - Usage->committed - - Usage->init - - Usage->max - - Usage->used - # mapping and conversion expressions, use these and aliasField above to calculate metrics value - # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值 - # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - name=Name - - committed=Usage->committed - - init=Usage->init - - max=Usage->max - - used=Usage->used - protocol: jmx - jmx: - # host: ipv4 ipv6 domain - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # port - # 端口 - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - objectName: java.lang:type=MemoryPool,name=* - url: ^_^url^_^ -``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md deleted file mode 100644 index 9f7ae8ee1b1..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -id: extend-point -title: 自定义监控 -sidebar_label: 自定义监控 ---- - -> HertzBeat拥有自定义监控能力，您只需配置监控模版YML就能适配一款自定义的监控类型。 -> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 - -### 自定义流程 - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -### 监控模版YML - -**HertzBeat的设计是一个监控模版对应一个监控类型，所有监控类型都是由监控模版来定义的**。 - -> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 - -下面使用样例详细介绍下这监控模版YML的配置用法。 - -样例：自定义一个 `app` 名称为 `example2` 的自定义监控类型，其使用HTTP协议采集指标数据。 - -[监控模版] -> [新增监控类型] -> [右边配置如下监控模版YML] -> [保存并应用] - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# The monitoring type eg: linux windows tomcat mysql aws... -# 监控类型 eg: linux windows tomcat mysql aws... -app: example2 -# The monitoring i18n name -# 监控类型国际化名称 -name: - zh-CN: 模拟网站监测 - en-US: EXAMPLE WEBSITE -# 监控所需输入参数定义(根据定义渲染页面UI) -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - # field-变量字段标识符 - - field: host - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # field-param field key - # field-变量字段标识符 - - field: port - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: number - # when type is number, range is required - # 当type为number时,用range表示范围 - range: '[0,65535]' - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # default value - # 默认值 - defaultValue: 80 - # field-param field key - # field-变量字段标识符 - - field: uri - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 相对路径 - en-US: URI - # type-param field type(most mapping the html input tag) - # type-字段类型,样式(大部分映射input标签type属性) - type: text - # when type is text, use limit to limit string length - # 当type为text时,用limit表示字符串限制大小 - limit: 200 - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: false - # 参数输入框提示信息 - # param field input placeholder - placeholder: 'Website uri path(no ip port) EG:/console' - # field-param field key - # field-变量字段标识符 - - field: ssl - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 启用HTTPS - en-US: HTTPS - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: boolean - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # field-param field key - # field-变量字段标识符 - - field: timeout - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - # type-param field type(most mapping the html input tag) - # type-字段类型,样式(大部分映射input标签type属性) - type: number - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: false - # hide param-true or false - # 是否隐藏字段 true or false - hide: true - -metrics: - # metrics - summary, inner monitoring metrics (responseTime - response time, keyword - number of keywords) - # 监控指标 - summary, 内置监控指标有 (responseTime - 响应时间, keyword - 关键字数量) - - name: summary - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # collect metrics content - # 具体监控指标列表 - fields: - # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label - # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 - - field: responseTime - type: 0 - unit: ms - - field: keyword - type: 0 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # the config content when protocol is http - http: - # http host: ipv4 ipv6 domain - host: ^_^host^_^ - # http port - port: ^_^port^_^ - # http url - url: ^_^uri^_^ - timeout: ^_^timeout^_^ - # http method: GET POST PUT DELETE PATCH - method: GET - # if enabled https - ssl: ^_^ssl^_^ - # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule - # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控, prometheus-Prometheus数据规则 - parseType: website - -``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-push.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-push.md deleted file mode 100644 index 7245afe2a12..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-push.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: extend-push -title: Push Style Custom Monitoring -sidebar_label: Push Style Custom Monitoring ---- - -> 推送方式监控是一种特殊的监控，允许用户配置数据格式并编写代码将指标推送到 Hertzbeat。 -> 下面我们将介绍如何使用这一功能。 - -### 推送方式监控的采集流程 - -【用户开始推送数据】->【HertzBeat推送模块暂存数据】->【HertzBeat采集模块定期采集数据】 - -### 数据解析方式 - -HertzBeat会使用用户添加新监控时配置的格式来解析数据。 - -### 创建监控步骤 - -HertzBeat页面 -> 应用服务监控 -> 推送方式监控 -> 新建推送方式监视器 -> 设置推送模块主机（Hertzbeat服务器ip，通常为127.0.0.1或localhost） -> 设置推送模块端口（hertzbeat服务器端口，通常为1157） -> 配置数据字段（单位：字符串表示，类型：0表示数字/1表示字符串）-> 结束 - ---- - -### 监控配置示例 - -![](/img/docs/advanced/extend-push-example-1.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md deleted file mode 100644 index 1172b263c2e..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -id: extend-snmp -title: SNMP协议自定义监控 -sidebar_label: SNMP协议自定义监控 ---- - -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 -> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 - -### SNMP协议采集流程 - -【**对端开启SNMP服务**】->【**HertzBeat直连对端SNMP服务**】->【**根据配置抓取对端OID指标信息**】->【**指标数据提取**】 - -由流程可见，我们自定义一个SNMP协议的监控类型，需要配置SNMP请求参数，配置获取哪些指标，配置查询OID信息。 - -### 数据解析方式 - -通过配置监控模版YML的指标`field`, `aliasFields`, `snmp` 协议下的 `oids`来抓取对端指定的数据并解析映射。 - -### 自定义步骤 - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -下面详细介绍下文件的配置用法，请注意看使用注释。 - -### 监控模版YML - -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 - -样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: os -# The monitoring type eg: linux windows tomcat mysql aws... -# 监控类型 eg: linux windows tomcat mysql aws... -app: windows -# The monitoring i18n name -# 监控类型国际化名称 -name: - zh-CN: Windows操作系统 - en-US: OS Windows -# 监控所需输入参数定义(根据定义渲染页面UI) -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - # field-变量字段标识符 - - field: host - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # field-param field key - # field-变量字段标识符 - - field: port - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: number - # when type is number, range is required - # 当type为number时,用range表示范围 - range: '[0,65535]' - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # default value - # 默认值 - defaultValue: 161 - # field-param field key - # field-变量字段标识符 - - field: version - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: SNMP 版本 - en-US: SNMP Version - # type-param field type(radio mapping the html radio tag) - # type-当type为radio时,前端用radio展示开关 - type: radio - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} - # 当type为radio单选框, checkbox复选框时, option表示可选项值列表 {name1:value1,name2:value2} - options: - - label: SNMPv1 - value: 0 - - label: SNMPv2c - value: 1 - # field-param field key - # field-变量字段标识符 - - field: community - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: SNMP 团体字 - en-US: SNMP Community - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: text - # when type is text, use limit to limit string length - # 当type为text时,用limit表示字符串限制大小 - limit: 100 - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # 参数输入框提示信息 - # param field input placeholder - placeholder: 'Snmp community for v1 v2c' - # field-param field key - # field-变量字段标识符 - - field: timeout - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: number - # when type is number, range is required - # 当type为number时,用range表示范围 - range: '[0,100000]' - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: false - # hide-is hide this field and put it in advanced layout - # hide-是否隐藏此参数将其放入高级设置中 - hide: true - # default value - # 默认值 - defaultValue: 6000 -# collect metrics config list -# 采集指标配置列表 -metrics: - # metrics - system - # 监控指标 - system - - name: system - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # collect metrics content - # 具体监控指标列表 - fields: - # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label - # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 - - field: name - type: 1 - - field: descr - type: 1 - - field: uptime - type: 1 - - field: numUsers - type: 0 - - field: services - type: 0 - - field: processes - type: 0 - - field: responseTime - type: 0 - unit: ms - - field: location - type: 1 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: snmp - # the config content when protocol is snmp - snmp: - # server host: ipv4 ipv6 domain - host: ^_^host^_^ - # server port - port: ^_^port^_^ - # snmp connect timeout - timeout: ^_^timeout^_^ - # snmp community - # snmp 团体字 - community: ^_^community^_^ - # snmp version - version: ^_^version^_^ - # snmp operation: get, walk - operation: get - # metrics oids: metric_name - oid_value - oids: - name: 1.3.6.1.2.1.1.5.0 - descr: 1.3.6.1.2.1.1.1.0 - uptime: 1.3.6.1.2.1.25.1.1.0 - numUsers: 1.3.6.1.2.1.25.1.5.0 - services: 1.3.6.1.2.1.1.7.0 - processes: 1.3.6.1.2.1.25.1.6.0 - location: 1.3.6.1.2.1.1.6.0 -``` diff --git a/home/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 deleted file mode 100644 index 0300c14b31d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -id: extend-ssh -title: SSH协议自定义监控 -sidebar_label: SSH协议自定义监控 ---- - -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 -> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 - -### SSH协议采集流程 - -【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 - -由流程可见，我们自定义一个SSH协议的监控类型，需要配置SSH请求参数，配置获取哪些指标，配置查询脚本语句。 - -### 数据解析方式 - -SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有两种：oneRow, multiRow，能满足绝大部分指标需求。 - -#### **oneRow** - -> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 - -例如： -需要查询Linux的指标 hostname-主机名称，uptime-启动时间 -主机名称原始查询命令：`hostname` -启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` -则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： -`hostname; uptime | awk -F "," '{print $1}'` -终端响应的数据为： - -``` -tombook -14:00:15 up 72 days -``` - -则最后采集到的指标数据一一映射为： -hostname值为 `tombook` -uptime值为 `14:00:15 up 72 days` - -这里指标字段就能和响应数据一一映射为一行采集数据。 - -#### **multiRow** - -> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 - -例如： -查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 -内存指标原始查询命令为：`free -m`, 控制台响应： - -```shell - total used free shared buff/cache available -Mem: 7962 4065 333 1 3562 3593 -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}'` -控制台响应为： - -```shell -total used free buff_cache available -7962 4066 331 3564 3592 -``` - -这里指标字段就能和响应数据一一映射为采集数据。 - -### 自定义步骤 - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -下面详细介绍下文件的配置用法，请注意看使用注释。 - -### 监控模版YML - -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 - -样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 - -```yaml -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: os -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example_linux -name: - zh-CN: 模拟LINUX应用类型 - en-US: LINUX EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量，即可以用^_^host^_^的形式写到后面的配置中，系统自动变量值替换 -# 强制固定必须参数 - host -params: - - field: host - name: - zh-CN: 主机Host - en-US: Host - type: host - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 22 - placeholder: '请输入端口' - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: true - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: true -# collect metrics config list -# 采集指标配置列表 -metrics: - # 第一个监控指标 basic - # 注意：内置监控指标有 (responseTime - 响应时间) - - name: basic - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: hostname - type: 1 - label: true - - field: version - type: 1 - - field: uptime - type: 1 - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: ssh - # 当protocol为http协议时具体的采集配置 - ssh: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - script: (uname -r ; hostname ; uptime | awk -F "," '{print $1}' | sed "s/ //g") | sed ":a;N;s/\n/^/g;ta" | awk -F '^' 'BEGIN{print "version hostname uptime"} {print $1, $2, $3}' - # 响应数据解析方式：oneRow, multiRow - parseType: multiRow - - - name: cpu - priority: 1 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: info - type: 1 - - field: cores - type: 0 - unit: 核数 - - field: interrupt - type: 0 - unit: 个数 - - field: load - type: 1 - - field: context_switch - type: 0 - unit: 个数 - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: ssh - # 当protocol为http协议时具体的采集配置 - ssh: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - script: "LANG=C lscpu | awk -F: '/Model name/ {print $2}';awk '/processor/{core++} END{print core}' /proc/cpuinfo;uptime | sed 's/,/ /g' | awk '{for(i=NF-2;i<=NF;i++)print $i }' | xargs;vmstat 1 1 | awk 'NR==3{print $11}';vmstat 1 1 | awk 'NR==3{print $12}'" - parseType: oneRow - - - name: memory - priority: 2 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: total - type: 0 - unit: Mb - - field: used - type: 0 - unit: Mb - - field: free - type: 0 - unit: Mb - - field: buff_cache - type: 0 - unit: Mb - - field: available - type: 0 - unit: Mb - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: ssh - # 当protocol为http协议时具体的采集配置 - ssh: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - 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 deleted file mode 100644 index 273fb4b4406..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -id: extend-tutorial -title: 自定义适配一款基于HTTP协议的新监控类型 -sidebar_label: 教程案例 ---- - -通过此教程我们一步一步描述如何在hertzbeat监控系统下自定义新增适配一款基于http协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 - -### HTTP协议解析通用响应结构体，获取指标数据 - -> 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - -``` -{ - "code": 200, - "msg": "success", - "data": {} -} - -``` - -如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API -`http://localhost:1157/api/summary`, 其响应数据为: - -``` -{ - "msg": null, - "code": 0, - "data": { - "apps": [ - { - "category": "service", - "app": "jvm", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - }, - { - "category": "service", - "app": "website", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - } - ] - } -} -``` - -**我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - -### 新增配置监控模版YML - -**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** - -定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 - -定义采集类型是啥，需要用哪种协议采集方式，采集的指标是啥，协议的配置参数等。我们直接复用 `api`监控模版 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可，如下：注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# The monitoring type eg: linux windows tomcat mysql aws... -# 监控类型 eg: linux windows tomcat mysql aws... -app: hertzbeat -# The monitoring i18n name -# 监控类型国际化名称 -name: - zh-CN: HertzBeat监控系统 - en-US: HertzBeat Monitor -# Input params define for monitoring(render web ui by the definition) -# 监控所需输入参数定义(根据定义渲染页面UI) -params: - # field-param field key - # field-字段名称标识符 - - field: host - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # required-true or false - # 是否是必输项 true-必填 false-可选 - required: true - # field-param field key - # field-变量字段标识符 - - field: port - # name-param field display i18n name - # name-参数字段显示名称 - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - # type-字段类型,样式(大部分映射input标签type属性) - type: number - # when type is number, range is required - # 当type为number时,用range表示范围 - range: '[0,65535]' - # required-true or false - # required-是否是必输项 true-必填 false-可选 - required: true - # default value - # 端口默认值 - defaultValue: 1157 - - field: ssl - name: - zh-CN: 启用HTTPS - en-US: HTTPS - type: boolean - required: true - - field: timeout - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - type: number - required: false - hide: true - - field: authType - name: - zh-CN: 认证方式 - en-US: Auth Type - type: radio - required: false - hide: true - options: - - label: Basic Auth - value: Basic Auth - - label: Digest Auth - value: Digest Auth - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: false - hide: true - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - hide: true -metrics: - # the first metrics summary - # attention: Built-in monitoring metrics contains (responseTime - Response time) - - name: summary - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # collect metrics content - # 具体监控指标列表 - fields: - # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: app - type: 1 - label: true - - field: category - type: 1 - - field: status - type: 0 - - field: size - type: 0 - - field: availableSize - type: 0 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here - # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk, 我们这里使用HTTP协议 - protocol: http - # the config content when protocol is http - # 当protocol为http协议时具体的采集配置 - http: - # http host: ipv4 ipv6 domain - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # http port - # 端口 - port: ^_^port^_^ - # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary - # url请求接口路径，我们这里不需要输入传参，写死为 /api/summary - url: /api/summary - timeout: ^_^timeout^_^ - # http method: GET POST PUT DELETE PATCH, default fixed value is GET - # 请求方式 GET POST PUT DELETE PATCH，写死为 GET - method: GET - # if enabled https, default value is false - # 是否启用ssl/tls,即是http还是https,默认false - ssl: ^_^ssl^_^ - # http auth - # 认证 - authorization: - # http auth type: Basic Auth, Digest Auth, Bearer Token - # 认证方式: Basic Auth, Digest Auth, Bearer Token - type: ^_^authType^_^ - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - digestAuthUsername: ^_^username^_^ - digestAuthPassword: ^_^password^_^ - # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控，我们这里使用jsonpath来解析响应数据 - parseType: jsonPath - parseScript: '$.data.apps.*' -``` - -**点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`hertzbeat`监控类型了。** - -![](/img/docs/advanced/extend-http-example-1.png) - -### 页面添加对`hertzbeat`监控类型的监控 - -> 我们点击新增 `HertzBeat监控系统`，配置监控IP，端口，采集周期，高级设置里的账户密码等, 点击确定添加监控。 - -![](/img/docs/advanced/extend-http-example-2.png) - -![](/img/docs/advanced/extend-http-example-3.png) - -> 过一定时间(取决于采集周期)我们就可以在监控详情看到具体的指标数据和历史图表啦！ - -![](/img/docs/advanced/extend-http-example-4.png) - -### 设置阈值告警通知 - -> 接下来我们就可以正常设置阈值，告警触发后可以在告警中心查看，也可以新增接收人，设置告警通知等，Have Fun!!! - ----- - -#### 完 - -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 deleted file mode 100644 index 94e2ad54899..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -id: activemq -title: 监控 Apache ActiveMQ 消息中间件 -sidebar_label: ActiveMQ消息中间件 -keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监控] ---- - -> 对 Apache ActiveMQ 消息中间件的运行状态，节点，Topic等相关指标进行监测。 - -**使用协议：JMX** - -### 监控前操作 - -> 您需要在 ActiveMQ 开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 ActiveMQ 进行指标采集。 - -1. 修改安装目录下的 `conf/activemq.xml` 文件，开启JMX - -> 在 `broker` 标签中添加 `userJmx="true"` 属性 - -```xml - - - -``` - -2. 修改安装目录下的 `bin/env` 文件，配置JMX 端口 IP等 - -将如下原配置信息 - -```text -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.port=11099" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=${ACTIVEMQ_CONF}/jmx.password" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=${ACTIVEMQ_CONF}/jmx.access" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false" - -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" -``` - -更新为如下配置，⚠️注意修改`本机对外IP` - -```text -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=${ACTIVEMQ_CONF}/jmx.password" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=${ACTIVEMQ_CONF}/jmx.access" - -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.port=11099" -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false" -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.authenticate=false" -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Djava.rmi.server.hostname=本机对外IP" - -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" -``` - -3. 重启 ACTIVEMQ 服务，在 HertzBeat 添加对应 ActiveMQ 监控即可，参数使用 JMX 配置的 IP 端口。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|---------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| JMX端口 | JMX 对外提供的HTTP端口，默认为 11099。 | -| JMX URL | 可选，自定义 JMX URL 连接 | -| 用户名 | 认证时使用的用户名 | -| 密码 | 认证时使用的密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：broker - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------|------|-----------------------------------------------------------------------| -| BrokerName | 无 | The name of the broker. | -| BrokerVersion | 无 | The version of the broker. | -| Uptime | 无 | Uptime of the broker. | -| UptimeMillis | ms | Uptime of the broker in milliseconds. | -| Persistent | 无 | Messages are synchronized to disk. | -| MemoryPercentUsage | % | Percent of memory limit used. | -| StorePercentUsage | % | Percent of store limit used. | -| TempPercentUsage | % | Percent of temp limit used. | -| CurrentConnectionsCount | 无 | Attribute exposed for management | -| TotalConnectionsCount | 无 | Attribute exposed for management | -| TotalEnqueueCount | 无 | Number of messages that have been sent to the broker. | -| TotalDequeueCount | 无 | Number of messages that have been acknowledged on the broker. | -| TotalConsumerCount | 无 | Number of message consumers subscribed to destinations on the broker. | -| TotalProducerCount | 无 | Number of message producers active on destinations on the broker. | -| TotalMessageCount | 无 | Number of unacknowledged messages on the broker. | -| AverageMessageSize | 无 | Average message size on this broker | -| MaxMessageSize | 无 | Max message size on this broker | -| MinMessageSize | 无 | Min message size on this broker | - -#### 指标集合：topic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------|------|-------------------------------------------------------------------------------------------| -| Name | 无 | Name of this destination. | -| MemoryLimit | MB | Memory limit, in bytes, used by undelivered messages before paging to temporary storage. | -| MemoryPercentUsage | 无 | The percentage of the memory limit used | -| ProducerCount | 无 | Number of producers attached to this destination | -| ConsumerCount | 无 | Number of consumers subscribed to this destination. | -| EnqueueCount | 无 | Number of messages that have been sent to the destination. | -| DequeueCount | 无 | Number of messages that has been acknowledged (and removed) from the destination. | -| ForwardCount | 无 | Number of messages that have been forwarded (to a networked broker) from the destination. | -| InFlightCount | 无 | Number of messages that have been dispatched to, but not acknowledged by, consumers. | -| DispatchCount | 无 | Number of messages that has been delivered to consumers, including those not acknowledged | -| ExpiredCount | 无 | Number of messages that have been expired. | -| StoreMessageSize | B | The memory size of all messages in this destination's store. | -| AverageEnqueueTime | ms | Average time a message was held on this destination. | -| MaxEnqueueTime | ms | The longest time a message was held on this destination | -| MinEnqueueTime | ms | The shortest time a message was held on this destination | -| TotalBlockedTime | ms | Total time (ms) messages have been blocked by flow control | -| AverageMessageSize | B | Average message size on this destination | -| MaxMessageSize | B | Max message size on this destination | -| MinMessageSize | B | Min message size on this destination | - -#### 指标集合：memory_pool - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：class_loading - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------|------|----------| -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - -#### 指标集合：thread - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------|------|-----------| -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md deleted file mode 100644 index a7f77f7f5b6..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: airflow -title: 监控：Apache Airflow监控 -sidebar_label: Apache Airflow -keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ---- - -> 对Apache Airflow通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|-----------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：airflow_health - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|------------------| -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | - -#### 指标集合：airflow_version - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|---------------| -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_console.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_console.md deleted file mode 100644 index 5198b961b66..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_console.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: alert_console -title: 告警模板中自定义的控制台地址 -sidebar_label: 告警模板登录台地址 ---- - -> 阈值触发后发送告警信息，通过钉钉/企业微信/飞书机器人通知或者使用邮箱通知的时候，告警内容中有登录控制台的详情链接 - -### 自定义设置 - -在我们的启动配置文件application.yml中，找到下面的配置 - -```yml -alerter: - console-url: #这里就是我们的自定义控制台地址 -``` - -默认值是赫兹跳动的官方控制台地址 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 deleted file mode 100644 index ba6b49bc58a..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: alert_dingtalk -title: 告警钉钉机器人通知 -sidebar_label: 告警钉钉机器人通知 -keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 - -### 操作步骤 - -1. **【钉钉桌面客户端】-> 【群设置】-> 【智能群助手】-> 【添加新建机器人-选自定义】-> 【设置机器人名称头像】-> 【注意⚠️设置自定义关键字: HertzBeat】 ->【添加成功后复制其WebHook地址】** - -> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 - -![email](/img/docs/help/alert-notice-8.png) - -2. **【保存机器人的WebHook地址access_token值】** - -> 例如： 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. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-4.png) - -### 钉钉机器人通知常见问题 - -1. 钉钉群未收到机器人告警通知 - -> 请排查在告警中心是否已有触发的告警信息 -> 请排查钉钉机器人是否配置了安全自定义关键字：HertzBeat -> 请排查是否配置正确机器人ACCESS_TOKEN，是否已配置告警策略关联 - -其它问题可以通过交流群ISSUE反馈哦！ 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 deleted file mode 100644 index bb3c6287cd4..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: alert_discord -title: 告警 Discord 机器人通知 -sidebar_label: 告警 Discord 机器人通知 -keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 - -## 操作步骤 - -> 部署网络本身需支持科学上网，不支持设置代理 - -### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token - -1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 - -![bot](/img/docs/help/discord-bot-1.png) - -2. 在应用下创建机器人，获取机器人 Token - -![bot](/img/docs/help/discord-bot-2.png) - -![bot](/img/docs/help/discord-bot-3.png) - -3. 授权机器人到聊天服务器 - -> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` - -![bot](/img/docs/help/discord-bot-4.png) - -> 获取到最下方生成的 URL, 浏览器访问此 URL 给机器人正式授权，即设置将机器人加入哪个聊天服务器。 - -4. 查看您的聊天服务器是否已经加入机器人成员 - -![bot](/img/docs/help/discord-bot-5.png) - -### 开启开发者模式，获取频道 Channel ID - -1. 个人设置 -> 高级设置 -> 开启开发者模式 - -![bot](/img/docs/help/discord-bot-6.png) - -2. 获取频道 Channel ID - -> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID - -![bot](/img/docs/help/discord-bot-7.png) - -### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot - -1. **【告警通知】->【新增接收人】 ->【选择 Discord 机器人通知方式】->【设置机器人Token和ChannelId】-> 【确定】** - -![email](/img/docs/help/discord-bot-8.png) - -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-policy.png) - -### Discord 机器人通知常见问题 - -1. Discord 未收到机器人告警通知 - -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人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 deleted file mode 100644 index 0f53b58e71d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: alert_email -title: 告警邮件通知 -sidebar_label: 告警邮件通知 -keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过邮件通知到接收人。 - -### 操作步骤 - -1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** - -![email](/img/docs/help/alert-notice-1.png) - -2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** - ![email](/img/docs/help/alert-notice-2.png) - -![email](/img/docs/help/alert-notice-3.png) - -3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-4.png) - -### 邮件通知常见问题 - -1. 自己内网部署的HertzBeat无法接收到邮件通知 - -> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 - -2. 云环境TanCloud无法接收到邮件通知 - -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确邮箱，是否已配置告警策略关联 -> 请查询邮箱的垃圾箱里是否把告警邮件拦截 - -其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_enterprise_wechat_app.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_enterprise_wechat_app.md deleted file mode 100644 index b70c8b10c40..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_enterprise_wechat_app.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: alert_enterprise_wechat_app -title: 企业微信应用告警通知 -sidebar_label: 企业微信应用告警通知 -keywords: [开源告警系统, 开源监控告警系统, 企业微信应用告警通知] ---- - -> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. - -### Operation steps - -1. **【企业微信后台管理】-> 【App管理】-> 【创建一个新的应用】-> 【设置应用信息】->【添加成功后复制应用的AgentId和Secret】** - -![email](/img/docs/help/alert-wechat-1.jpg) - -2. **【告警通知】->【新增接收人】 ->【选择企业微信应用通知方式】->【设置企业ID,企业应用id和应用的secret 】-> 【确定】** - -![email](/img/docs/help/alert-wechat-2.jpg) - -3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** - -![email](/img/docs/help/alert-wechat-3.jpg) - -### 企业微信应用通知常见问题 - -1. 企业微信应用未收到告警通知. - -> 请检查用户是否具有应用程序权限. -> 请检查企业应用程序回调地址设置是否正常. -> 请检查服务器IP是否在企业应用程序白名单上. - -其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/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 deleted file mode 100644 index 5a6e95d7067..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: alert_feishu -title: 告警飞书机器人通知 -sidebar_label: 告警飞书机器人通知 -keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 - -### 操作步骤 - -1. **【飞书客户端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** - -2. **【保存机器人的WebHook地址的KEY值】** - -> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` - -3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** - -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-4.png) - -### 飞书机器人通知常见问题 - -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 deleted file mode 100644 index 5c5c38c56be..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: alert_slack -title: 告警 Slack Webhook 通知 -sidebar_label: 告警 Slack Webhook 通知 -keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 - -## 操作步骤 - -> 部署网络本身需支持科学上网，不支持设置代理 - -### 在 Slack 开启 Webhook, 获取 Webhook URL - -参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) - -### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook - -1. **【告警通知】->【新增接收人】 ->【选择 Slack Webhook 通知方式】->【设置 Webhook URL】-> 【确定】** - -![email](/img/docs/help/slack-bot-1.png) - -2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-policy.png) - -### Slack 机器人通知常见问题 - -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 deleted file mode 100644 index d6bca9843a4..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_smn.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: alert_smn -title: 华为云SMN通知 -sidebar_label: 告警华为云SMN通知 -keywords: [ 告警华为云SMN通知, 开源告警系统, 开源监控告警系统 ] ---- - -> 阈值触发后发送告警信息，通过华为云SMN通知到接收人。 - -### 操作步骤 - -1. **按照[华为云SMN官方文档](https://support.huaweicloud.com/qs-smn/smn_json.html)开通SMN服务并配置SMN** - -![alert-notice-10](/img/docs/help/alert-notice-10.png) - -2. **保存SMN的主题URN** - -![alert-notice-11](/img/docs/help/alert-notice-11.png) - -3. **按照[华为云签名文档](https://support.huaweicloud.com/devg-apisign/api-sign-provide.html)获取AK、SK和项目ID** - -![alert-notice-12](/img/docs/help/alert-notice-12.png) - -![alert-notice-13](/img/docs/help/alert-notice-13.png) - -4. **【告警通知】->【新增接收人】 ->【选择华为云SMN通知方式】->【设置华为云SMN AK、SK等配置】-> 【确定】** - -![alert-notice-14](/img/docs/help/alert-notice-14.png) - -5. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-4.png) - -### 华为云SMN通知常见问题 - -1. 华为云SMN群未收到告警通知 - -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否正确配置华为云SMN AK、SK等配置，是否已配置告警策略关联 - -其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/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 deleted file mode 100644 index dfb1aa48d8a..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: alert_telegram -title: 告警 Telegram 机器人通知 -sidebar_label: 告警 Telegram 机器人通知 -keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 - -## 操作步骤 - -> 部署网络本身需支持科学上网，不支持设置代理 - -### 在 Telegram 创建机器人, 获取 Bot Token 和 UserId - -1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` - -![telegram-bot](/img/docs/help/telegram-bot-1.png) - -2. 获取接收人的 `User ID` - -**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, -访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` - -```json -{ - "ok":true, - "result":[ - { - "update_id":632299191, - "message":{ - "from":{ - "id": "User ID" - }, - "chat":{ - }, - "date":1673858065, - "text":"111" - } - } - ] -} -``` - -3. 记录保存我们获得的 `Token` 和 `User Id` - -### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot - -1. **【告警通知】->【新增接收人】 ->【选择 Telegram 机器人通知方式】->【设置机器人Token和UserId】-> 【确定】** - -![email](/img/docs/help/telegram-bot-2.png) - -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-policy.png) - -### Telegram 机器人通知常见问题 - -1. Telegram 未收到机器人告警通知 - -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人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 deleted file mode 100644 index 9a68175fad7..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: alert_threshold -title: 阈值告警配置 -sidebar_label: 阈值告警配置 ---- - -> 对监控指标配置告警阈值(警告告警，严重告警，紧急告警)，系统根据阈值配置和采集指标数据计算触发告警。 - -### 操作步骤 - -1. **【告警配置】->【新增阈值】-> 【配置后确定】** - -![threshold](/img/docs/help/alert-threshold-1.png) - -如上图： - -**指标对象**：选择我们需要配置阈值的监控指标对象 例如：网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标 -**阈值触发表达式**：根据此表达式来计算判断是否触发阈值，表达式环境变量和操作符见页面提示，例如：设置响应时间大于50触发告警，表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr) -**告警级别**：触发阈值的告警级别,从低到高依次为:警告-warning，严重-critical，紧急-emergency -**触发次数**：设置触发阈值多少次之后才会真正的触发告警 -**通知模版**：告警触发后发送的通知信息模版,模版环境变量见页面提示，例如：`${app}.${metrics}.${metric}指标的值为${responseTime}，大于50触发告警` -**全局默认**： 设置此阈值是否对全局的此类指标都应用有效，默认否。新增阈值后还需将阈值与监控对象关联，这样阈值才会对此监控生效。 -**启用告警**：此告警阈值配置开启生效或关闭 - -2. **阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】** - -> **注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效)，这样阈值才会对此监控生效**。 - -![threshold](/img/docs/help/alert-threshold-2.png) - -![threshold](/img/docs/help/alert-threshold-3.png) - -**阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。** -**若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。** - -其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/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 deleted file mode 100644 index 6d15d14ea6e..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: alert_threshold_expr -title: 阈值触发表达式 -sidebar_label: 阈值触发表达式 ---- - -> 在我们配置阈值告警时，需要配置阈值触发表达式，系统根据表达式和监控指标值计算触发是否告警，这里详细介绍下表达式使用。 - -#### 表达式支持的操作符 - -``` -equals(str1,str2) -== -< -<= -> ->= -!= -( ) -+ -- -&& -|| -``` - -丰富的操作符让我们可以很自由的定义表达式。 -注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 != - -#### 表达式函数库列表 - -参考: - -#### 支持的环境变量 - -> 环境变量即指标值等支持的变量，用于在表达式中，阈值计算判断时会将变量替换成实际值进行计算 - -非固定环境变量：这些变量会根据我们选择的监控指标对象而动态变化，例如我们选择了**网站监控的响应时间指标**，则环境变量就有 `responseTime - 此为响应时间变量` -如果我们想设置**网站监控的响应时间大于400时**触发告警，则表达式为 `responseTime>400` - -固定环境变量(不常用)：`instance : 所属行实例值` -此变量主要用于计算多实例时，比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警，则表达式为 `equals(instance,"c")&&usage>80` - -#### 表达式设置案例 - -1. 网站监控->响应时间大于等于400ms时触发告警 - `responseTime>=400` -2. API监控->响应时间大于3000ms时触发告警 - `responseTime>3000` -3. 全站监控->URL(instance)路径为 `https://baidu.com/book/3` 的响应时间大于200ms时触发告警 - `equals(instance,"https://baidu.com/book/3")&&responseTime>200` -4. MYSQL监控->status指标->threads_running(运行线程数)指标大于7时触发告警 - `threads_running>7` - -若遇到问题可以通过交流群ISSUE交流反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md deleted file mode 100644 index 272c59cfd4c..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: alert_webhook -title: 告警 Webhook 回调通知 -sidebar_label: 告警 Webhook 回调通知 -keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 - -## 操作步骤 - -1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** - -![email](/img/docs/help/alert-notice-5.png) - -2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-4.png) - -### WebHook回调POST请求体BODY内容 - -内容格式：JSON - -```json -{ - "alarmId": 76456, - "target": "${target}", - "thresholdId": 33455, - "priority": 0, - "content": "udp_port monitoring availability alert, code is FAIL", - "status": 0, - "times": 1, - "triggerTime": "2022-02-25T13:32:13", - "tags": { - "app": "windows", - "monitorId": "180427708350720", - "metrics": "availability", - "code": "UN_CONNECTABLE", - "thresholdId": "112", - "monitorName": "WINDOWS_192.168.124.12" - } -} -``` - -| | | -|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| alarmId | integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID | -| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field | -| thresholdId | integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID | -| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 | -| content | string title: The actual content of the alarm notification 告警通知实际内容 | -| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 | -| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 | -| triggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) | -| tags | example: {key1:value1} | - -### webhook通知常见问题 - -1. WebHook回调未生效 - -> 请查看告警中心是否已经产生此条告警信息 -> 请排查配置的WebHook回调地址是否正确 - -其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/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 deleted file mode 100644 index 5c73ffee2a6..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: alert_wework -title: 告警企业微信通知 -sidebar_label: 告警企业微信通知 -keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 - -### 操作步骤 - -1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** - -![email](/img/docs/help/alert-notice-6.jpg) - -2. **【保存机器人的WebHook地址的KEY值】** - -> 例如： 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. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 - -![email](/img/docs/help/alert-notice-4.png) - -### 企业微信机器人通知常见问题 - -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 deleted file mode 100644 index 0390259fc70..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: api -title: 监控：HTTP API -sidebar_label: HTTP API -keywords: [开源监控系统, 开源网站监控, HTTP API监控] ---- - -> 调用HTTP API接口，查看接口是否可用，对其响应时间等指标进行监测 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------------|-------------------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 请求方式 | 设置接口调用的请求方式：GET,POST,PUT,DELETE。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 用户名 | 接口Basic认证或Digest认证时使用的用户名 | -| 密码 | 接口Basic认证或Digest认证时使用的密码 | -| Content-Type | 设置携带BODY请求体数据请求时的资源类型 | -| 请求BODY | 设置携带BODY请求体数据，PUT POST请求方式时有效 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：summary - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|--------| -| 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 deleted file mode 100644 index 02a93f751c5..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: centos -title: 监控：CentOS操作系统监控 -sidebar_label: CentOS操作系统 -keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监控] ---- - -> 对CentOS操作系统的通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------|------|--------| -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | - -#### 指标集合：cpu - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|--------------------| -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | - -#### 指标集合：memory - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|----------| -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | - -#### 指标集合：disk - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|-----------| -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | - -#### 指标集合：interface - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|---------------| -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | - -#### 指标集合：disk_free - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|---------| -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| 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 deleted file mode 100644 index 12cb13b8422..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: dm -title: 监控：达梦数据库监控 -sidebar_label: 达梦数据库 -keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] ---- - -> 对DM达梦数据库的通用性能指标进行采集监控。支持DM8+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5236。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|-----------| -| PORT_NUM | 无 | 数据库暴露服务端口 | -| CTL_PATH | 无 | 控制文件路径 | -| MAX_SESSIONS | 无 | 数据库最大连接数 | - -#### 指标集合：status - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|------------| -| status$ | 无 | DM数据库的开闭状态 | - -#### 指标集合：thread - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|---------------------------------| -| 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 deleted file mode 100644 index 0b81365780b..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -id: docker -title: 监控：Docker 监控 -sidebar_label: Docker 容器监控 -keywords: [开源监控系统, 开源容器监控, Docker容器监控] ---- - -> 对Docker容器的通用性能指标进行采集监控。 - -## 监控前操作 - -如果想要监控 `Docker` 中的容器信息，则需要按照一下步骤打开端口，让采集请求获取到对应的信息。 - -**1、编辑docker.server文件：** - -```shell -vi /usr/lib/systemd/system/docker.service -``` - -找到 **[Service]** 节点，修改 ExecStart 属性，增加 `-H tcp://0.0.0.0:2375` - -```shell -ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock -H tcp://0.0.0.0:2375 -``` - -这样相当于对外开放的是 **2375** 端口，当然也可以根据自己情况修改成其他的。 - -**2、重新加载Docker配置生效：** - -```shell -systemctl daemon-reload -systemctl restart docker -``` - -**注意：记得在服务器中打开 `2375` 端口号。** - -**3、如果上述方法不行则：** - -在服务器内部打开 `2375` 端口号。 - -```shell -firewall-cmd --zone=public --add-port=2375/tcp --permanent -firewall-cmd --reload -``` - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为2375。 | -| 查询超时时间 | 设置获取Docker服务器API接口时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 器名称 | 一般是监控所有运行中的容器信息。 | -| 用户名 | 连接用户名，可选 | -| 密码 | 连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：system - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------|------|--------------------------------| -| Name | 无 | 服务器名称 | -| version | 无 | docker本版号 | -| os | 无 | 服务器版本 例如：linux x86_64 | -| root_dir | 无 | docker文件夹目录 例如：/var/lib/docker | -| containers | 无 | 容器总数（在运行+未运行） | -| containers_running | 无 | 运行中的容器数目 | -| containers_paused | 无 | 暂停中的容器数目 | -| images | 无 | 容器景象的总数目。 | -| ncpu | 无 | NCPU | -| mem_total | MB | 占用的内存总大小 | -| system_time | 无 | 系统时间 | - -#### 指标集合：containers - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|----------------| -| id | 无 | Docker中容器的ID | -| name | 无 | Docker容器中的容器名称 | -| image | 无 | Docker容器使用的镜像 | -| command | 无 | Docker中的默认启动命令 | -| state | 无 | Docker中容器的运行状态 | -| status | 无 | Docker容器中的更新时间 | - -#### 指标集合：stats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------------|------|--------------------| -| name | 无 | Docker容器中的名字 | -| available_memory | MB | Docker容器可以利用的内存大小 | -| used_memory | MB | Docker容器已经使用的内存大小 | -| memory_usage | 无 | Docker容器的内存使用率 | -| 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 deleted file mode 100644 index 1abcb732289..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -id: dynamic_tp -title: 监控：DynamicTp 线程池监控 -sidebar_label: DynamicTp线程池监控 -keywords: [开源监控系统, 开源中间件监控, DynamicTp线程池监控] ---- - -> 对DynamicTp actuator 暴露的线程池性能指标进行采集监控。 - -### 前提 - -1. 集成使用 `DynamicTp` - -`DynamicTp` 是Jvm语言的基于配置中心的轻量级动态线程池，内置监控告警功能，可通过SPI自定义扩展实现。 - -集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) - -2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 - -```yaml -management: - endpoints: - web: - exposure: - include: '*' -``` - -测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: - -```json -[ - { - "poolName": "commonExecutor", - "corePoolSize": 1, - "maximumPoolSize": 1, - "queueType": "LinkedBlockingQueue", - "queueCapacity": 2147483647, - "queueSize": 0, - "fair": false, - "queueRemainingCapacity": 2147483647, - "activeCount": 0, - "taskCount": 0, - "completedTaskCount": 0, - "largestPoolSize": 0, - "poolSize": 0, - "waitTaskCount": 0, - "rejectCount": 0, - "rejectHandlerName": null, - "dynamic": false, - "runTimeoutCount": 0, - "queueTimeoutCount": 0 - }, - { - "maxMemory": "4 GB", - "totalMemory": "444 MB", - "freeMemory": "250.34 MB", - "usableMemory": "3.81 GB" - } -] -``` - -3. 在HertzBeat中间件监控下添加DynamicTp监控即可 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|-----------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：thread_pool - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------|------|--------------------------| -| pool_name | 无 | 线程池名称 | -| core_pool_size | 无 | 核心线程数 | -| maximum_pool_size | 无 | 最大线程数 | -| queue_type | 无 | 任务队列类型 | -| queue_capacity | MB | 任务队列容量 | -| queue_size | 无 | 任务队列当前占用大小 | -| fair | 无 | 队列模式，SynchronousQueue会用到 | -| queue_remaining_capacity | MB | 任务队列剩余大小 | -| active_count | 无 | 活跃线程数 | -| task_count | 无 | 任务总数 | -| completed_task_count | 无 | 已完成任务数 | -| largest_pool_size | 无 | 历史最大线程数 | -| pool_size | 无 | 当前线程数 | -| wait_task_count | 无 | 等待执行任务数 | -| reject_count | 无 | 拒绝任务数 | -| reject_handler_name | 无 | 拒绝策略类型 | -| 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 deleted file mode 100644 index 54553c1200c..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: fullsite -title: 监控：全站监控 -sidebar_label: 全站监控 -keywords: [开源监控系统, 开源网站监控, SiteMap监控] ---- - -> 对网站的全部页面监测是否可用 -> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 -> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|---------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 网站地图 | 网站SiteMap地图地址的相对路径，例如：/sitemap.xml。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：summary - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|-----------------| -| url | 无 | 网页的URL路径 | -| 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 deleted file mode 100644 index da07e912f00..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: guide -title: 帮助中心 -sidebar_label: 帮助入门 ---- - -> 易用友好的实时监控工具，无需Agent，强大自定义监控能力。 -> 使用过程中的帮助文档,辅助信息。 - -## 🔬 监控服务 - -> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 -> 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 - -### 应用服务监控 - - 👉 [网站监测](website)
- 👉 [HTTP API](api)
- 👉 [PING连通性](ping)
- 👉 [端口可用性](port)
- 👉 [全站监控](fullsite)
- 👉 [SSL证书有效期](ssl_cert)
- 👉 [JVM虚拟机](jvm)
- 👉 [SpringBoot2.0](springboot2)
- -### 数据库监控 - - 👉 [MYSQL数据库监控](mysql)
- 👉 [MariaDB数据库监控](mariadb)
- 👉 [PostgreSQL数据库监控](postgresql)
- 👉 [SqlServer数据库监控](sqlserver)
- 👉 [Oracle数据库监控](oracle)
- 👉 [达梦数据库监控](dm)
- 👉 [OpenGauss数据库监控](opengauss)
- 👉 [IoTDB数据库监控](iotdb)
- -### 操作系统监控 - - 👉 [Linux操作系统监控](linux)
- 👉 [Windows操作系统监控](windows)
- 👉 [Ubuntu操作系统监控](ubuntu)
- 👉 [Centos操作系统监控](centos)
- -### 中间件监控 - - 👉 [Zookeeper](zookeeper)
- 👉 [Kafka](kafka)
- 👉 [Tomcat](tomcat)
- 👉 [ShenYu](shenyu)
- 👉 [DynamicTp](dynamic_tp)
- 👉 [RabbitMQ](rabbitmq)
- 👉 [ActiveMQ](activemq)
- 👉 [Jetty](jetty)
- -### 云原生监控 - - 👉 [Docker](docker)
- 👉 [Kubernetes](kubernetes)
- -## 💡 告警服务 - -> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 -> 告警服务的定位是阈值准确及时触发，告警通知及时可达。 - -### 告警中心 - -> 已触发的告警信息中心，提供告警删除，告警处理，标记未处理，告警级别状态等查询过滤。 - -### 告警配置 - -> 指标阈值配置，提供表达式形式的指标阈值配置，可设置告警级别，触发次数，告警通知模版和是否启用，关联监控等功能。 - -详见 👉 [阈值告警](alert_threshold)
-   👉 [阈值表达式](alert_threshold_expr) - -### 告警通知 - -> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 -> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 -> 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。 - - 👉 [配置邮箱通知](alert_email)
- 👉 [配置 Webhook 通知](alert_webhook)
- 👉 [配置 Telegram 通知](alert_telegram)
- 👉 [配置 Discord 通知](alert_discord)
- 👉 [配置 Slack 通知](alert_slack)
- 👉 [配置企业微信机器人通知](alert_wework)
- 👉 [配置钉钉机器人通知](alert_dingtalk)
- 👉 [配置飞书机器人通知](alert_feishu)
- 👉 [配置华为云SMN通知](alert_smn)
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 deleted file mode 100644 index 186baede498..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: hadoop -title: 监控：Hadoop -sidebar_label: Hadoop -keywords: [开源监控系统, 开源JAVA监控, Hadoop的JVM虚拟机监控] ---- - -> 对Hadoop的JVM虚拟机的通用性能指标进行采集监控 - -**使用协议：JMX** - -### 监控前操作 - -> 您需要在 Hadoop 应用开启 `JMX` 服务，HertzBeat 使用 JMX 协议对Hadoop中的 JVM 进行指标采集。 - -#### Hadoop应用开启JMX协议步骤 - -应用启动时添加JVM参数 ⚠️注意可自定义暴露端口,对外IP - -- 1.进入hadoop-env.sh配置文件，在命令行终端输入以下命令： - -```shell -vi $HADOOP_HOME/etc/hadoop/hadoop-env.sh -``` - -- 2.添加如下参数，`` 为自定义暴露端口号。 - -```shell -export HADOOP_OPTS= "$HADOOP_OPTS --Djava.rmi.server.hostname=对外ip地址 --Dcom.sun.management.jmxremote.port=9999 --Dcom.sun.management.jmxremote.ssl=false --Dcom.sun.management.jmxremote.authenticate=false " -``` - -- 3.保存并退出，并在 $HADOOP_HOME/sbin 目录下执行 `start-all.sh` 重启服务。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：memory_pool - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：code_cache (限JDK8及以下) - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：class_loading - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------|------|----------| -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - -#### 指标集合：thread - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------|------|-----------| -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md deleted file mode 100644 index 6e1efde0991..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: hive -Title: 监控 Apache Hive -sidebar_label: Apache Hive -keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标] ---- - -> 收集和监控由 SpringBoot Actuator 提供的常规性能指标。 - -## 监控前操作 - -如果您想使用此监控类型监控 Apache Hive 的信息，您需要以远程模式启动您的 Hive Server2。 - -**1、启用元数据存储:** - -```shell -hive --service metastore & -``` - -**2. 启用 Hive Server2:** - -```shell -hive --service hiveserver2 & -``` - -### 配置参数 - -| 参数名称 | 参数描述 | -|----------|--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 10002。 | -| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | - -### 采集指标 - -#### 指标收集: 基本信息 - -| 指标名称 | 指标单位 | 指标描述 | -|--------|------|-----------------------------| -| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | -| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | -| 虚拟机版本 | 无 | 虚拟机的版本。 | -| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | - -#### 指标收集: 环境信息 - -| 指标名称 | 指标单位 | 指标描述 | -|------------|------|--------------------------------| -| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | -| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | -| 操作系统版本 | 无 | 操作系统的版本。 | -| 操作系统架构 | 无 | 操作系统的架构。 | -| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | -| java运行环境版本 | 无 | Java 运行时环境的版本。 | - -#### 指标收集: 线程信息 - -| 指标名称 | 指标单位 | 指标描述 | -|--------|------|------------------------------| -| 线程数量 | None | HiveServer2 当前正在使用的线程数。 | -| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | -| 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 | -| 守护线程数 | None | HiveServer2 当前活动的守护线程数。 | - -#### 指标收集: 代码缓存 - -| 指标名称 | 指标单位 | 指标描述 | -|------------|------|---------------| -| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | -| 内存池初始内存 | MB | 内存池请求的初始内存量。 | -| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | -| 内存池内存使用量 | MB | 内存池已使用内存量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md deleted file mode 100644 index 8bb3bbb25e0..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -id: iotdb -title: 监控 Apache IoTDB 物联网时序数据库 -sidebar_label: IoTDB数据库 -keywords: [开源监控系统, 开源数据库监控, IoTDB数据库监控] ---- - -> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 - -## 监控前操作 - -您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 - -开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) - -主要如下步骤: - -1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server - -``` -# 是否启动监控模块，默认为false -enableMetric: true - -# 是否启用操作延迟统计 -enablePerformanceStat: false - -# 数据提供方式，对外部通过jmx和prometheus协议提供metrics的数据, 可选参数：[JMX, PROMETHEUS, IOTDB],IOTDB是默认关闭的。 -metricReporterList: - - JMX - - PROMETHEUS - -# 底层使用的metric架构，可选参数：[MICROMETER, DROPWIZARD] -monitorType: MICROMETER - -# 初始化metric的级别，可选参数: [CORE, IMPORTANT, NORMAL, ALL] -metricLevel: IMPORTANT - -# 预定义的指标集, 可选参数: [JVM, LOGBACK, FILE, PROCESS, SYSTEM] -predefinedMetrics: - - JVM - - FILE -``` - -2. 重启 IoTDB, 打开浏览器或者用curl 访问 , 就能看到metric数据了。 - -3. 在 HertzBeat 添加对应 IoTDB 监控即可。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | IoTDB指标接口对外提供的端口，默认为9091。 | -| 超时时间 | HTTP请求查询超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：cluster_node_status - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-------------------------| -| name | 无 | 节点名称IP | -| status | 无 | 节点状态，1=online 2=offline | - -#### 指标集合：jvm_memory_committed_bytes - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------| -| area | 无 | heap内存或nonheap内存 | -| id | 无 | 内存区块 | -| value | MB | 当前向JVM申请的内存大小 | - -#### 指标集合：jvm_memory_used_bytes - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------| -| area | 无 | heap内存或nonheap内存 | -| id | 无 | 内存区块 | -| value | MB | JVM已使用内存大小 | - -#### 指标集合：jvm_threads_states_threads - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------| -| state | 无 | 线程状态 | -| count | 无 | 线程状态对应线程数量 | - -#### 指标集合：quantity 业务数据 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--|------|----------------| -| name | 无 | 业务名称 timeSeries/storageGroup/device/deviceUsingTemplate | -| type | 无 | 类型 total/normal/template/template | -| value | 无 | 当前时间timeSeries/storageGroup/device/激活了模板的device的数量 | - -#### 指标集合：cache_hit 缓存 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------------------------------| -| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | -| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | - -#### 指标集合：queue 任务队列 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|----------------------------------------------| -| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | -| status | 无 | 状态 running/waiting | -| value | 无 | 当前时间任务数 | - -#### 指标集合：thrift_connections - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|-------------| -| 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 deleted file mode 100644 index 3d06e0346d2..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: issue -title: 常见问题 -sidebar_label: 常见问题 ---- - -### 监控常见问题 - -1. **页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名** - -> 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http - -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安装默认启用无此问题 -> 详见 - -4. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖服务TDengine时序数据库] - -> 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - TDengine数据库 -> 安装初始化此数据库参考 [TDengine安装初始化](../start/tdengine-init) - -5. 配置了k8s监控，但是实际监控时间并未按照正确间隔时间执行 - 请参考下面几点排查问题： - -> 一：首先查看hertzbeat的错误日志，如果出现了'desc: SQL statement too long, check maxSQLLength config'，信息 -> 二：需要调整tdengine配置文件，可在服务器创建taos.cfg文件，调整# max length of an SQL : maxSQLLength 654800，然后重启tdengine，需要加入配置文件的挂载 -> 三：如果遇到了重启tdengine失败，需要调整挂载数据文件中的配置，见 .../taosdata/dnode/dnodeEps.json，中dnodeFqdn调整为启动失败的dockerId即可，然后docker restart tdengine -> 6.配置http api监控，用于进行业务接口探测，确保业务可以用，另外接口有进行token鉴权校验，"Authorization：Bearer eyJhbGciOiJIUzI1...."，配置后测试，提示“StatusCode 401”。服务端应用收到的token为"Authorization：Bearer%20eyJhbGciOiJIUzI1....",hertzbeat对空格进行转义为“%20”，服务器没有转义导致鉴权失败，建议转义功能作为可选项。 - -### Docker部署常见问题 - -1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** - 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 - -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` - -2. **按照流程部署，访问 无界面** - 请参考下面几点排查问题： - -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 -> 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 -> 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 - -3. **日志报错TDengine连接或插入SQL失败** - -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - -### 安装包部署常见问题 - -1. **按照流程部署，访问 无界面** - 请参考下面几点排查问题： - -> 一：依赖服务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 deleted file mode 100644 index 31e297703fc..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: jetty -title: 监控：Jetty应用服务器 -sidebar_label: Jetty应用服务器 -keywords: [开源监控系统, 开源中间件监控, Jetty应用服务器监控] ---- - -> 对Jetty应用服务器的通用性能指标进行采集监控 - -**使用协议：JMX** - -### 监控前操作 - -> 您需要在 JVM 应用开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 JVM 进行指标采集。 - -#### Jetty应用服务器开启JMX协议步骤 - -[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) - -1. 在 Jetty 启动 JMX JMX-REMOTE 模块 - -```shell -java -jar $JETTY_HOME/start.jar --add-module=jmx -java -jar $JETTY_HOME/start.jar --add-module=jmx-remote -``` - -命令执行成功会创建出 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件 - -2. 编辑 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件，修改 JMX 的 IP 端口等参数。 - -**`localhost` 需修改为对外暴露 IP** - -```text -## The host/address to bind the RMI server to. -# jetty.jmxremote.rmiserverhost=localhost - -## The port the RMI server listens to (0 means a random port is chosen). -# jetty.jmxremote.rmiserverport=1099 - -## The host/address to bind the RMI registry to. -# jetty.jmxremote.rmiregistryhost=localhost - -## The port the RMI registry listens to. -# jetty.jmxremote.rmiregistryport=1099 - -## The host name exported in the RMI stub. --Djava.rmi.server.hostname=localhost -``` - -3. 重启 Jetty Server 即可。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：memory_pool - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：class_loading - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------|------|----------| -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - -#### 指标集合：thread - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------|------|-----------| -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md deleted file mode 100644 index 3d9e96e55e1..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -id: jvm -title: 监控：JVM虚拟机监控 -sidebar_label: JVM虚拟机 -keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] ---- - -> 对JVM虚拟机的通用性能指标进行采集监控 - -**使用协议：JMX** - -### 监控前操作 - -> 您需要在 JVM 应用开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 JVM 进行指标采集。 - -#### JVM应用开启JMX协议步骤 - -应用启动时添加JVM参数 ⚠️注意可自定义暴露端口,对外IP - -参考文档: - -```shell --Djava.rmi.server.hostname=对外ip地址 --Dcom.sun.management.jmxremote.port=9999 --Dcom.sun.management.jmxremote.ssl=false --Dcom.sun.management.jmxremote.authenticate=false -``` - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：memory_pool - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：code_cache (限JDK8及以下) - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：class_loading - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------|------|----------| -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - -#### 指标集合：thread - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------|------|-----------| -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md deleted file mode 100644 index a79bb0e91c2..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: kafka -title: 监控：Kafka监控 -sidebar_label: Kafka监控 -keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] ---- - -> 对Kafka的通用性能指标进行采集监控 - -**使用协议：JMX** - -### 监控前操作 - -> 您需要在 Kafka 开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 Kafka 进行指标采集。 - -1. 安装部署 Kafka 服务 - -2. 修改 Kafka 启动脚本 - -修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` -在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 - -```shell -export JMX_PORT=9999; -export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management.jmxremote.rmi.port=9999 -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false"; - -# 这是最后一行本来就存在的 -# exec $base_dir/kafka-run-class.sh $EXTRA_ARGS kafka.Kafka "$@" -``` - -3. 重启 Kafka 服务 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：server_info - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|---------| -| Version | 无 | Kafka版本 | -| StartTimeMs | ms | 运行时间 | -| CommitId | 无 | 版本提交ID | - -#### 指标集合：code_cache - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：active_controller_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------| -| Value | 个 | 活跃监控器数量 | - -#### 指标集合：broker_partition_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------| -| Value | 个 | 分区数量 | - -#### 指标集合：broker_leader_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------| -| Value | 个 | 领导者数量 | - -#### 指标集合：broker_handler_avg_percent 请求处理器空闲率 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|----------|---------| -| EventType | 无 | 类型 | -| RateUnit | 具体情况具体分析 | 单位 | -| Count | 个 | 数量 | -| OneMinuteRate | % | 一分钟处理率 | -| FiveMinuteRate | % | 五分钟处理率 | -| MeanRate | 无 | 平均处理率 | -| 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 deleted file mode 100644 index 4f0363f621d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: kubernetes -title: 监控：Kubernetes 监控 -sidebar_label: Kubernetes 监控 -keywords: [开源监控系统, 开源Kubernetes监控] ---- - -> 对kubernetes的通用性能指标进行采集监控。 - -## 监控前操作 - -如果想要监控 `Kubernetes` 中的信息，则需要获取到可访问Api Server的授权TOKEN，让采集请求获取到对应的信息。 - -参考获取token步骤 - -#### 方式一 - -1. 创建service account并绑定默认cluster-admin管理员集群角色 - -```kubectl create serviceaccount dashboard-admin -n kube-system``` - -2. 用户授权 - -```shell -kubectl create clusterrolebinding dashboard-admin --clusterrole=cluster-admin --serviceaccount=kube-system:dashboard-admin -kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' -kubectl describe secret {secret} -n kube-system -``` - -#### 方式二 - -``` -kubectl create serviceaccount cluster-admin - -kubectl create clusterrolebinding cluster-admin-manual --clusterrole=cluster-admin --serviceaccount=default:cluster-admin - -kubectl create token --duration=1000h cluster-admin - -``` - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|-------------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| APiServer端口 | K8s APiServer端口，默认6443 | -| token | 授权Access Token | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：nodes - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------|------|--------| -| node_name | 无 | 节点名称 | -| is_ready | 无 | 节点状态 | -| capacity_cpu | 无 | CPU容量 | -| allocatable_cpu | 无 | 已分配CPU | -| capacity_memory | 无 | 内存容量 | -| allocatable_memory | 无 | 已分配内存 | -| creation_time | 无 | 节点创建时间 | - -#### 指标集合：namespaces - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|-------------| -| namespace | 无 | namespace名称 | -| status | 无 | 状态 | -| creation_time | 无 | 创建时间 | - -#### 指标集合：pods - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|----------------| -| pod | 无 | pod名称 | -| namespace | 无 | pod所属namespace | -| status | 无 | pod状态 | -| restart | 无 | 重启次数 | -| host_ip | 无 | 所在主机IP | -| pod_ip | 无 | pod ip | -| creation_time | 无 | pod创建时间 | -| start_time | 无 | pod启动时间 | - -#### 指标集合：services - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|--------------------------------------------------------| -| service | 无 | service名称 | -| namespace | 无 | service所属namespace | -| type | 无 | service类型 ClusterIP NodePort LoadBalancer ExternalName | -| 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 deleted file mode 100644 index abd87de1ef8..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: linux -title: 监控：Linux操作系统监控 -sidebar_label: Linux操作系统 -keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控] ---- - -> 对Linux操作系统的通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------|------|--------| -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | - -#### 指标集合：cpu - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|--------------------| -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | - -#### 指标集合：memory - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|----------| -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | - -#### 指标集合：disk - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|-----------| -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | - -#### 指标集合：interface - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|---------------| -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | - -#### 指标集合：disk_free - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|---------| -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| 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 deleted file mode 100644 index 4690b5500ef..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: mariadb -title: 监控：MariaDB数据库监控 -sidebar_label: MariaDB数据库 -keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] ---- - -> 对MariaDB数据库的通用性能指标进行采集监控。支持MariaDB5+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|------------| -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | - -#### 指标集合：status - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|------|------------------| -| threads_created | 无 | MariaDB已经创建的总连接数 | -| threads_connected | 无 | MariaDB已经连接的连接数 | -| threads_cached | 无 | MariaDB当前缓存的连接数 | -| threads_running | 无 | MariaDB当前活跃的连接数 | - -#### 指标集合：innodb - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------|------|-------------------------| -| innodb_data_reads | 无 | innodb平均每秒从文件中读取的次数 | -| 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 deleted file mode 100644 index f3c1ddfab55..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: memcached -title: Monitoring Memcached -sidebar_label: Memcached Monitor -keywords: [ open source monitoring tool, open source Memcached monitoring tool, monitoring memcached metrics ] ---- - -> Collect and monitor the general performance Metrics of Memcached. - -**Protocol Use：Memcached** - -```text -The default YML configuration for the memcache version is in compliance with 1.4.15. -You need to use the stats command to view the parameters that your memcache can monitor -``` - -### - -**1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. - -```shell -# telnet ip port -[root@server ~]# telnet localhost 11211 -Trying ::1... -Connected to localhost. -Escape character is '^]'. -stats -STAT pid 15168 -STAT uptime 11691 -STAT time 1702569246 -STAT version 1.4.15 -... -``` - -**There is help_doc: ** - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Memcached | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：server_info - -| Metric name | Metric unit | Metric help description | -|------------------|-------------|---------------------------------------------------| -| pid | | Memcache server process ID | -| uptime | s | The number of seconds the server has been running | -| version | | Memcache version | -| curr_connections | | Current number of connections | -| auth_errors | | Number of authentication failures | -| threads | | Current number of threads | -| item_size | byte | The size of the item | -| item_count | | Number of items | -| curr_items | | The total number of data currently stored | -| total_items | | The total number of data stored since startup | -| bytes | byte | The current number of bytes occupied by storage | -| cmd_get | | Get command request count | -| cmd_set | | Set command request count | -| cmd_flush | | Flush command request count | -| get_misses | | Get command misses | -| delete_misses | | Delete command misses | 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 deleted file mode 100644 index 47087c88f34..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: mysql -title: 监控：MYSQL数据库监控 -sidebar_label: MYSQL数据库 -keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ---- - -> 对MYSQL数据库的通用性能指标进行采集监控。支持MYSQL5+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|------------| -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | - -#### 指标集合：status - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|------|----------------| -| threads_created | 无 | MySql已经创建的总连接数 | -| threads_connected | 无 | MySql已经连接的连接数 | -| threads_cached | 无 | MySql当前缓存的连接数 | -| threads_running | 无 | MySql当前活跃的连接数 | - -#### 指标集合：innodb - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------|------|-------------------------| -| innodb_data_reads | 无 | innodb平均每秒从文件中读取的次数 | -| 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 deleted file mode 100644 index 9faed580e1b..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -id: nebulaGraph -title: 监控 NebulaGraph 数据库 -sidebar_label: NebulaGraph 数据库 -keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGraph 指标 ] ---- - -> 收集和监控 NebulaGraph 的常规性能指标。 - -**使用协议：nebulaGraph** - -```text -监控分为两个部分，nebulaGraph_stats 和 rocksdb_stats。 -nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 -``` - -### - -**1、通过 stats 和 rocksdb stats 接口获取可用参数。** - -1.1、如果只需要获取 nebulaGraph_stats，需要确保可以访问 stats，否则会出现错误。 - -默认端口是 19669，访问地址为 - -1.2、如果需要获取 rocksdb stats 的附加参数，需要确保可以访问 rocksdb stats，否则会报错。 - -首次连接 NebulaGraph 时，必须先注册 Storage 服务，以便正确查询数据。 - -**有帮助文档：** - -**** - -默认端口是 19779，访问地址为： - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|-------------|--------------------------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️没有协议头（例如：https://、http://） | -| 监控名称 | 识别此监控的名称。名称需要唯一 | -| graphPort | Nebula Graph 提供的 Graph 服务的端口 | -| timePeriod | 可以是 5 秒、60 秒、600 秒或 3600 秒，分别表示最近 5 秒、最近 1 分钟、最近 10 分钟和最近 1 小时的时间段 | -| storagePort | Nebula Graph 提供的 Storage 服务的端口 | -| 超时 | 允许收集响应时间 | -| 收集间隔 | 监控周期性数据收集的间隔时间，单位：秒，最小可设置的间隔为 30 秒 | -| 是否检测 | 是否检测和验证添加监控之前的可用性。只有检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用于识别和描述此监控的更多信息，用户可以在此处记录信息 | - -### 收集指标 - -#### 指标集：nebulaGraph_stats - -指标太多，相关链接如下 -**** - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------------------------------------------------------|------|--------| -| 达到内存水位线的语句的数量(rate) | | | -| 达到内存水位线的语句的数量(sum) | | | -| 服务端主动回收的过期的会话数量(rate) | | | -| 服务端主动回收的过期的会话数量(sum) | | | -| 慢查询延迟时间(avg) | | | -| 慢查询延迟时间(p75) | | | -| 慢查询延迟时间(p95) | | | -| 慢查询延迟时间(p99) | | | -| 慢查询延迟时间(p999) | | | -| 查询延迟时间(avg) | | | -| 查询延迟时间(p75) | | | -| 查询延迟时间(p95) | | | -| 查询延迟时间(p99) | | | -| 查询延迟时间(p999) | | | -| 因用户名密码错误导验证失败的会话数量(rate) | | | -| 因用户名密码错误导验证失败的会话数量(sum) | | | -| 查询次数(rate) | | | -| 查询次数(sum) | | | -| 排序（Sort）算子执行时间(rate) | | | -| 排序（Sort）算子执行时间(sum) | | | -| Graphd 服务发给 Storaged 服务的 RPC 请求失败的数量(rate) | | | -| Graphd 服务发给 Storaged 服务的 RPC 请求失败的数量(sum) | | | -| 登录验证失败的会话数量(rate) | | | -| 登录验证失败的会话数量(sum) | | | -| 查询报错语句数量(rate) | | | -| 查询报错语句数量(sum) | | | -| 被终止的查询数量(rate) | | | -| 被终止的查询数量(sum) | | | -| 因查询错误而导致的 Leader 变更的次数(rate) | | | -| 因查询错误而导致的 Leader 变更的次数(sum) | | | -| Graphd 服务发给 Metad 服务的 RPC 请求数量(rate) | | | -| Graphd 服务发给 Metad 服务的 RPC 请求数量(sum) | | | -| 慢查询次数(rate) | | | -| 慢查询次数(sum) | | | -| 活跃的会话数的变化数(sum) | | | -| 活跃的查询语句数的变化数(sum) | | | -| Graphd 服务接收的语句数(rate) | | | -| Graphd 服务接收的语句数(sum) | | | -| 聚合（Aggregate）算子执行时间(rate) | | | -| 聚合（Aggregate）算子执行时间(sum) | | | -| 优化器阶段延迟时间(avg) | | | -| 优化器阶段延迟时间(p75) | | | -| 优化器阶段延迟时间(p95) | | | -| 优化器阶段延迟时间(p99) | | | -| 优化器阶段延迟时间(p999) | | | -| Graphd 服务发给 Metad 的 RPC 请求失败的数量(rate) | | | -| Graphd 服务发给 Metad 的 RPC 请求失败的数量(sum) | | | -| 索引扫描（IndexScan）算子执行时间(rate) | | | -| 索引扫描（IndexScan）算子执行时间(sum) | | | -| 服务端建立过的会话数量(rate) | | | -| 服务端建立过的会话数量(sum) | | | -| 因为超过FLAG_OUT_OF_MAX_ALLOWED_CONNECTIONS参数导致的验证登录的失败的会话数量(rate) | | | -| 因为超过FLAG_OUT_OF_MAX_ALLOWED_CONNECTIONS参数导致的验证登录的失败的会话数量(sum) | | | -| Graphd 服务发给 Storaged 服务的 RPC 请求数量(rate) | | | -| Graphd 服务发给 Storaged 服务的 RPC 请求数量(sum) | | | - -#### 指标集：rocksdb_stats - -指标太多，相关链接如下 -**** - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------------------|------|------------------------| -| 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 deleted file mode 100644 index 8c81c5a82c2..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -id: nginx -title: 监控 Nginx -sidebar_label: Nginx 监控 -keywords: [开源监控工具, 开源Java监控工具, 监控Nginx指标] ---- - -> 收集和监控 Nginx 的常规性能指标。 - -**使用的协议：Nginx** - -### 需要启用 Nginx 的 `ngx_http_stub_status_module` 和 `ngx_http_reqstat_module` 监控模块 - -如果你想使用这种监控方式监控 'Nginx' 的信息，你需要修改你的 Nginx 配置文件以启用监控模块。 - -### 启用 ngx_http_stub_status_module - -1. 检查是否已添加 `ngx_http_stub_status_module` - -```shell -nginx -V -``` - -查看是否包含 `--with-http_stub_status_module`，如果没有则需要重新编译安装 Nginx。 - -2. 编译安装 Nginx, 添加 `ngx_http_stub_status_module` 模块 - -下载 Nginx 并解压，在目录下执行 - -```shell -./configure --prefix=/usr/local/nginx --with-http_stub_status_module - -make && make install -``` - -3. 修改 Nginx 配置文件 - -修改 `nginx.conf` 文件，添加监控模块暴露端点，如下配置： - -```shell -# modify nginx.conf -server { - listen 80; # port - server_name localhost; - location /nginx-status { - stub_status on; - access_log on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts - } -} -``` - -4. 重新加载 Nginx - -```shell -nginx -s reload -``` - -5. 在浏览器访问 `http://localhost/nginx-status` 即可查看 Nginx 监控状态信息。 - -### 启用 `ngx_http_reqstat_module` - -1. 安装 `ngx_http_reqstat_module` 模块 - -```shell -# install `ngx_http_reqstat_module` -wget https://github.com/zls0424/ngx_req_status/archive/master.zip -O ngx_req_status.zip - -unzip ngx_req_status.zip - -patch -p1 < ../ngx_req_status-master/write_filter.patch - -./configure --prefix=/usr/local/nginx --add-module=/path/to/ngx_req_status-master - -make -j2 - -make install -``` - -2. 修改 Nginx 配置文件 - -修改 `nginx.conf` 文件，添加状态模块暴露端点，如下配置： - -```shell -# modify nginx.conf -http { - req_status_zone server_name $server_name 256k; - req_status_zone server_addr $server_addr 256k; - - req_status server_name server_addr; - - server { - location /req-status { - req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts - } - } -} -``` - -3. 重新加载 Nginx - -```shell -nginx -s reload -``` - -4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 - -**参考文档： ** - -**⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** - -### 配置参数 - -| 参数名 | 参数描述 | -|--------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | Nginx 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | - -### 收集指标 - -#### 指标收集：nginx_status - -| 指标名称 | 指标单位 | 指标描述 | -|-------|------|------------| -| 接收连接数 | | 已接受的连接 | -| 处理连接数 | | 成功处理的连接 | -| 活动连接数 | | 当前活动连接 | -| 丢弃连接数 | | 丢弃的连接 | -| 请求连接数 | | 客户端请求 | -| 读连接数 | | 正在执行读操作的连接 | -| 写连接数 | | 正在执行写操作的连接 | -| 等待连接数 | | 等待连接 | - -#### 指标集：req_status - -| 指标名称 | 指标单位 | 指标描述 | -|---------|------|---------| -| 分组类别 | | 分组类别 | -| 分组名称 | | 分组名称 | -| 最大并发连接数 | | 最大并发连接数 | -| 最大带宽 | kb | 最大带宽 | -| 总流量 | kb | 总流量 | -| 总请求数 | | 总请求数 | -| 当前并发连接数 | | 当前并发连接数 | -| 当前带宽 | kb | 当前带宽 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md deleted file mode 100644 index a160f2501e4..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: ntp -title: 监控 NTP 服务器 -sidebar_label: NTP 服务器 -keywords: [ open source monitoring tool, open source NTP monitoring tool, monitoring NTP metrics ] ---- - -NTP监控的中文文档如下： - -# NTP监控 - -> 收集和监控NTP的常规性能指标。 - -**协议使用：NTP** - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|------|--------------------------------------------------| -| 监控主机 | 被监控的IPv4、IPv6或域名。注意⚠️不包含协议头（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要是唯一的 | -| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒 | -| 是否检测 | 是否在添加监控之前检测和检查监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息 | - -### 采集指标 - -#### 指标集：概要 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------|------|--------------------------| -| 响应时间 | 毫秒 | NTP服务器响应请求所需的时间。 | -| 时间 | 毫秒 | NTP服务器报告的当前时间。 | -| 日期 | | 与NTP服务器报告的当前时间对应的日期。 | -| 偏移量 | 毫秒 | NTP服务器的时钟与客户端时钟之间的时间差。 | -| 延迟 | 毫秒 | 请求到达NTP服务器并返回响应所需的时间。 | -| 版本号 | | 服务器使用的NTP协议的版本号。 | -| 模式 | | NTP服务器的操作模式，如客户端、服务器或广播。 | -| 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 | -| 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | -| 精度 | | NTP服务器时钟的精度，表示其准确性。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md deleted file mode 100644 index 964fc909c33..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: opengauss -title: 监控：OpenGauss数据库监控 -sidebar_label: OpenGauss数据库 -keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] ---- - -> 对PostgreSQL数据库的通用性能指标进行采集监控。支持PostgreSQL 10+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|---------------| -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | - -#### 指标集合：state - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|--------------------------------------------------------------------------| -| name | 无 | 数据库名称，或share-object为共享对象。 | -| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | -| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | -| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | -| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | -| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | -| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | -| stats_reset | 无 | 这些统计信息上次被重置的时间 | - -#### 指标集合：activity - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|----------| -| 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 deleted file mode 100644 index d6bb80eb98d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: oracle -title: 监控：ORACLE数据库监控 -sidebar_label: ORACLE数据库 -keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] ---- - -> 对ORACLE数据库的通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1521。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------------|------|---------| -| database_version | 无 | 数据库版本 | -| database_type | 无 | 数据库类型 | -| hostname | 无 | 主机名称 | -| instance_name | 无 | 数据库实例名称 | -| startup_time | 无 | 数据库启动时间 | -| status | 无 | 数据库状态 | - -#### 指标集合：tablespace - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|---------| -| file_id | 无 | 文件ID | -| file_name | 无 | 文件名称 | -| tablespace_name | 无 | 所属表空间名称 | -| status | 无 | 状态 | -| bytes | MB | 大小 | -| blocks | 无 | 区块数量 | - -#### 指标集合：user_connect - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------|------|--------| -| username | 无 | 用户名 | -| counts | 个数 | 当前连接数量 | - -#### 指标集合：performance - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------|------|---------------------------------------| -| 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 deleted file mode 100644 index 59ac237ed34..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: ping -title: 监控：PING连通性 -sidebar_label: PING连通性 -keywords: [开源监控系统, 开源网络监控, 网络PING监控] ---- - -> 对对端HOST地址进行PING操作，判断其连通性 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|----------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：summary - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|--------| -| responseTime | ms毫秒 | 网站响应时间 | - -### 常见问题 - -1. 安装包部署的hertzbeat下ping连通性监控异常 - 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 - -> 安装包部署需要配置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 deleted file mode 100644 index 7a55a98df3e..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: pop3 -title: 监控POP3 -sidebar_label: POP3监控 -keywords: [开源监控工具，开源Java监控工具，监控POP3指标] ---- - -> 收集和监控POP3的常规性能指标。 - -**使用的协议：POP3** - -### 启用POP3服务 - -如果您想使用此监控类型来监控"POP3"的信息，请在您的邮件服务器上开启POP3服务。 - -**1、开启POP3服务：** - -```text -以qq邮箱为例【其它邮箱类似】： - 1. 点击`设置`选项 - 2. 选择`账号` - 3. 找到开启SMTP/POP3/IMAP选项，并开启 - 4. 得到POP3服务器域名，端口号，以及授权码【开启SMTP/POP3/IMAP服务后，qq邮箱提供】 - 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 -``` - -### 配置参数 - -| 参数名 | 参数描述 | -|--------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | POP3 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | - -### 采集指标 - -#### 指标集：email_status - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------| -| 邮件数量 | | 邮件数量 | -| 邮箱总大小 | kb | 邮箱中邮件的总大小 | diff --git a/home/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 deleted file mode 100644 index e774ac53254..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: port -title: 监控：端口可用性 -sidebar_label: 端口可用性 -keywords: [开源监控系统, 开源网络监控, 端口可用性监控] ---- - -> 判断对端服务暴露端口是否可用，进而判断对端服务是否可用，采集响应时间等指标进行监测 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：summary - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|--------| -| 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 deleted file mode 100644 index 12485e62ffa..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: postgresql -title: 监控：PostgreSQL数据库监控 -sidebar_label: PostgreSQL数据库 -keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] ---- - -> 对PostgreSQL数据库的通用性能指标进行采集监控。支持PostgreSQL 10+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|---------------| -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | - -#### 指标集合：state - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|--------------------------------------------------------------------------| -| name | 无 | 数据库名称，或share-object为共享对象。 | -| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | -| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | -| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | -| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | -| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | -| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | -| stats_reset | 无 | 这些统计信息上次被重置的时间 | - -#### 指标集合：activity - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|----------| -| 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 deleted file mode 100644 index 2210a2452e0..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -id: rabbitmq -title: 监控 RabbitMQ 消息中间件 -sidebar_label: RabbitMQ消息中间件 -keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间件监控] ---- - -> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 - -### 监控前操作 - -> HertzBeat 使用 RabbitMQ Management 的 Rest Api 对 RabbitMQ 进行指标数据采集。 -> 故需要您的 RabbitMQ 环境开启 Management 插件 - -1. 开启 Management 插件，或使用自开启版本 - -```shell -rabbitmq-plugins enable rabbitmq_management -``` - -2. 浏览器访问 ，默认账户密码 `guest/guest`. 成功登录即开启成功。 - -3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | -| 用户名 | 接口Basic认证时使用的用户名 | -| 密码 | 接口Basic认证时使用的密码 | -| 超时时间 | HTTP请求查询超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：overview - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------|------|--------------------------| -| product_version | 无 | 产品版本 | -| product_name | 无 | 产品名称 | -| rabbitmq_version | 无 | rabbitmq 版本 | -| management_version | 无 | rabbitmq management 插件版本 | -| erlang_version | 无 | erlang 版本 | -| cluster_name | 无 | 集群名称 | -| rates_mode | 无 | rates模式 | - -#### 指标集合：object_totals - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|-----------------| -| channels | 无 | channels的总数量 | -| connections | 无 | connections的总数量 | -| consumers | 无 | consumers的总数量 | -| exchanges | 无 | exchanges的总数量 | -| queues | 无 | queues的总数量 | - -#### 指标集合：nodes - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------|------|-------------------------------| -| name | 无 | The node name | -| type | 无 | The node type | -| running | 无 | Running state | -| os_pid | 无 | Pid in OS | -| mem_limit | MB | Memory usage high watermark | -| mem_used | MB | Total amount of memory used | -| fd_total | 无 | File descriptors available | -| fd_used | 无 | File descriptors used | -| sockets_total | 无 | Sockets available | -| sockets_used | 无 | Sockets used | -| proc_total | 无 | Erlang process limit | -| proc_used | 无 | Erlang processes used | -| disk_free_limit | GB | Free disk space low watermark | -| disk_free | GB | Free disk space | -| gc_num | 无 | GC runs | -| gc_bytes_reclaimed | MB | Bytes reclaimed by GC | -| context_switches | 无 | Context_switches num | -| io_read_count | 无 | 总共读操作的数量 | -| io_read_bytes | KB | 总共读入磁盘数据大小 | -| io_read_avg_time | ms | 读操作平均时间，毫秒为单位 | -| io_write_count | 无 | 磁盘写操作总量 | -| io_write_bytes | KB | 写入磁盘数据总量 | -| io_write_avg_time | ms | 每个磁盘写操作的平均时间，毫秒为单位 | -| io_seek_count | 无 | seek操作总量 | -| io_seek_avg_time | ms | seek操作的平均时间，毫秒单位 | -| io_sync_count | 无 | fsync操作的总量 | -| io_sync_avg_time | ms | fsync操作的平均时间，毫秒为单位 | -| connection_created | 无 | connection created num | -| connection_closed | 无 | connection closed num | -| channel_created | 无 | channel created num | -| channel_closed | 无 | channel closed num | -| queue_declared | 无 | queue declared num | -| queue_created | 无 | queue created num | -| queue_deleted | 无 | queue deleted num | -| connection_closed | 无 | connection closed num | - -#### 指标集合：queues - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------| -| name | 无 | The name of the queue with non-ASCII characters escaped as in C. | -| node | 无 | The queue on the node name | -| state | 无 | The state of the queue. Normally "running", but may be "{syncing, message_count}" if the queue is synchronising. | -| type | 无 | Queue type, one of: quorum, stream, classic. | -| vhost | 无 | vhost path | -| auto_delete | 无 | Whether the queue will be deleted automatically when no longer used | -| policy | 无 | Effective policy name for the queue. | -| consumers | 无 | Number of consumers. | -| memory | B | Bytes of memory allocated by the runtime for the queue, including stack, heap and internal structures. | -| messages_ready | 无 | Number of messages ready to be delivered to clients | -| messages_unacknowledged | 无 | Number of messages delivered to clients but not yet acknowledged | -| messages | 无 | Sum of ready and unacknowledged messages (queue depth) | -| messages_ready_ram | 无 | Number of messages from messages_ready which are resident in ram | -| messages_persistent | 无 | Total number of persistent messages in the queue (will always be 0 for transient queues) | -| message_bytes | B | Sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead | -| message_bytes_ready | B | Like message_bytes but counting only those messages ready to be delivered to clients | -| 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 deleted file mode 100644 index 0a0c9f77a65..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -id: redis -title: 监控：REDIS数据库监控 -sidebar_label: REDIS数据库 -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] ---- - -> 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：server - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------|------|-----------------------------------------------| -| redis_version | 无 | Redis 服务器版本 | -| redis_git_sha1 | 无 | Git SHA1 | -| redis_git_dirty | 无 | Git dirty flag | -| redis_build_id | 无 | redis 构建的id | -| redis_mode | 无 | redis模式（包括standalone, sentinel, cluster） | -| os | 无 | Redis 服务器的宿主操作系统 | -| arch_bits | 无 | 架构（32 或 64 位） | -| multiplexing_api | 无 | Redis使用的事件循环机制 | -| atomicvar_api | 无 | Redis使用的原子 API | -| gcc_version | 无 | 用于编译Redis服务器的GCC编译器版本 | -| process_id | 无 | 服务器进程的PID | -| process_supervised | 无 | 受监管系统（包括：upstart、systemd、unknown、no） | -| run_id | 无 | 标识Redis服务器的随机值（由Sentinel和Cluster使用） | -| tcp_port | 无 | TCP/IP侦听端口 | -| server_time_usec | 无 | 微秒级精度的基于时间的系统时间 | -| uptime_in_seconds | 无 | 自Redis服务器启动后的秒数 | -| uptime_in_days | 无 | 自Redis服务器启动后的天数 | -| hz | 无 | 服务器的当前频率设置，redis相关定时任务的执行频率（如清除过期key，关闭超时客户端） | -| configured_hz | 无 | 服务器配置的频率设置 | -| lru_clock | 无 | 时钟每分钟递增，用于LRU管理 | -| executable | 无 | 服务器可执行文件的路径 | -| config_file | 无 | 配置文件的路径 | -| io_threads_active | 无 | 指示I/O线程是否处于活动状态的标志 | -| shutdown_in_milliseconds | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。 | - -#### 指标集合：clients - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------------|------|--------------------------------------------------------------------------------| -| connected_clients | 无 | 客户端连接数（不包括来自副本的连接） | -| cluster_connections | 无 | 群集总线使用的套接字数量的近似值 | -| maxclients | 无 | maxclients配置指令的值。这是connected_clients、connected_slave和cluster_connections之和的上限。 | -| client_recent_max_input_buffer | byte | 当前客户端连接中最大的输入缓冲区 | -| client_recent_max_output_buffer | byte | 当前客户端连接中最大的输出缓冲区 | -| blocked_clients | 无 | 阻塞呼叫挂起的客户端数（BLPOP、BRPOP、BRPOPLPUSH、BLMOVE、BZPOPMIN、BZPOPMAX） | -| tracking_clients | 无 | 正在跟踪的客户端数（CLIENT TRACKING） | -| clients_in_timeout_table | 无 | 客户端超时表中的客户端数 | - -#### 指标集合：memory - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------|----------|-----------------------------------------------------------------------------------------------| -| used_memory | byte | Redis使用其分配器（标准libc、jemalloc或tcmalloc等替代分配器）分配的总字节数 | -| used_memory_human | GB/MB/KB | 上一个值的人类可读表示 | -| used_memory_rss | byte | 操作系统看到的Redis分配的字节数（也称为驻留集大小）。这是top（1）和ps（1）等工具报告的数字 | -| used_memory_rss_human | GB/MB/KB | 上一个值的人类可读值 | -| used_memory_peak | byte | Redis消耗的峰值内存（字节） | -| used_memory_peak_human | GB/MB/KB | 上一个值的人类可读值 | -| used_memory_peak_perc | 无 | used_memory_peak 与used_memory百分比 | -| used_memory_overhead | byte | 服务器分配用于管理其内部数据结构的所有开销的字节总和 | -| used_memory_startup | byte | Redis在启动时消耗的初始内存量（字节） | -| used_memory_dataset | byte | 数据集的字节大小（used_memory - used_memory_overhead） | -| used_memory_dataset_perc | 无 | 已用内存数据集占净内存使用量的百分比（used_memory_dataset / (used_memory - used_memory_startup)） | -| allocator_allocated | byte | 从分配器分配的总字节数，包括内部碎片。通常与使用的内存相同 | -| allocator_active | byte | 分配器活动页中的总字节数，包括外部碎片 | -| allocator_resident | byte | 分配器中驻留的总字节数（RSS），包括可释放到操作系统的页面（通过MEMORY PURGE或仅等待） | -| total_system_memory | byte | Redis主机的内存总量 | -| total_system_memory_human | GB/MB/KB | 上一个值的人类可读值 | -| used_memory_lua | byte | Lua引擎使用的字节数 | -| used_memory_lua_human | KB | 上一个值的人类可读值 | -| used_memory_scripts | byte | 缓存Lua脚本使用的字节数 | -| used_memory_scripts_human | GB/MB/KB | 上一值的人类可读值 | -| number_of_cached_scripts | 无 | 缓存的lua脚本数量 | -| maxmemory | byte | maxmemory配置指令的值 | -| maxmemory_human | GB/MB/KB | 上一个值的人类可读值 | -| maxmemory_policy | 无 | 当达到maxmemory时的淘汰策略 | -| allocator_frag_ratio | 无 | allocator_active 和 allocator_allocated之间的比率这是真实（外部）碎片度量（不是mem_fragmentation_ratio） | -| allocator_frag_bytes | byte | allocator_active 和 allocator_allocated 之间的差值。 | -| allocator_rss_ratio | | 从操作系统角度看, 内存分配器碎片比例 | -| allocator_rss_bytes | byte | allocator_resident 和 allocator_active之间的差值 | -| rss_overhead_ratio | 无 | used_memory_rss和allocator_resident之间的比率，这包括与分配器或堆无关的RSS开销 | -| rss_overhead_bytes | byte | used_memory_rss和allocator_resident之间的增量 | -| mem_fragmentation_ratio | 无 | used_memory_rss和used_memory之间的比率，注意，这不仅包括碎片，还包括其他进程开销（请参阅allocator_* metrics），以及代码、共享库、堆栈等开销。 | -| mem_fragmentation_bytes | byte | used_memory_rss和used_memory之间的增量。注意，当总碎片字节较低（几兆字节）时，高比率（例如1.5及以上）不是问题的表现 | -| mem_not_counted_for_evict | byte | 不应驱逐的内存大小,以字节为单位。这基本上是瞬时复制和AOF缓冲区。 | -| mem_replication_backlog | byte | 复制backlog的内存大小, 以字节为单位 | -| mem_clients_slaves | 无 | 副本客户端使用的内存-从Redis 7.0开始，副本缓冲区与复制积压工作共享内存，因此当副本不触发内存使用增加时，此字段可以显示0。 | -| mem_clients_normal | 无 | 普通客户端使用的内存 | -| mem_aof_buffer | 无 | 用于AOF和AOF重写缓冲区的临时大小 | -| mem_allocator | 无 | 内存分配器，在编译时选择。 | -| active_defrag_running | 无 | 启用activedefrag时，这表示碎片整理当前是否处于活动状态，以及它打算使用的CPU百分比。 | -| lazyfree_pending_objects | 无 | 等待释放的对象数（使用ASYNC选项调用UNLINK或FLUSHDB和FLUSHOLL） | -| lazyfreed_objects | 无 | 已延迟释放的对象数。 | - -#### 指标集合：persistence - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------------------------|--------|-----------------------------------------------------------------------------------------------------| -| loading | 无 | 服务器是否正在进行持久化 0 - 否 1 -是 | -| current_cow_size | byte | 运行子fork时写入时复制内存的大小（以字节为单位） | -| current_cow_size_age | second | current_cow_size值的年龄（以秒为单位） | -| current_fork_perc | 无 | 当前fork进程的百分比，对于AOF和RDB的fork，它是current_save_keys_processed占current_save_keys_total的百分比 | -| current_save_keys_processed | 无 | 当前保存操作处理的key的数量 | -| current_save_keys_total | 无 | 当前保存操作开始时的key的数量 | -| rdb_changes_since_last_save | 无 | 离最近一次成功生成rdb文件，写入命令的个数，即有多少个写入命令没有持久化 | -| rdb_bgsave_in_progress | 无 | 服务器是否正在创建rdb文件 0 - 否 1 - 是 | -| rdb_last_save_time | second | 最近一次创建rdb文件的时间戳,单位秒 | -| rdb_last_bgsave_status | 无 | 最近一次rdb持久化是否成功 ok 成功 | -| rdb_last_bgsave_time_sec | second | 最近一次成功生成rdb文件耗时秒数 | -| rdb_current_bgsave_time_sec | 无 | 如果服务器正在创建rdb文件，那么这个字段记录的就是当前的创建操作已经耗费的秒数 | -| rdb_last_cow_size | 无 | RDB过程中父进程与子进程相比执行了多少修改(包括读缓冲区，写缓冲区，数据修改等) | -| aof_enabled | 无 | 是否开启了AOF 0 - 否 1 - 是 | -| aof_rewrite_in_progress | 无 | 标识aof的rewrite操作是否在进行中 0 - 否 1- 是 | -| aof_rewrite_scheduled | 无 | rewrite任务计划，当客户端发送bgrewriteaof指令，如果当前rewrite子进程正在执行，那么将客户端请求的bgrewriteaof变为计划任务，待aof子进程结束后执行rewrite | -| aof_last_rewrite_time_sec | 无 | 最近一次aof rewrite耗费的时长 | -| aof_current_rewrite_time_sec | second | 如果rewrite操作正在进行，则记录所使用的时间，单位秒 | -| aof_last_bgrewrite_status | 无 | 上次 bgrewrite aof 操作的状态 ok 成功 | -| aof_last_write_status | 无 | 上次aof写入状态 | -| aof_last_cow_size | 无 | AOF过程中父进程与子进程相比执行了多少修改(包括读缓冲区，写缓冲区，数据修改等) | -| module_fork_in_progress | 无 | 指示fork模块正在进行的标志 | -| module_fork_last_cow_size | 无 | 上一次fork操作期间写入时复制内存的字节大小 | - -#### 指标集合：stats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------------|------|----------------------------------------------------| -| total_connections_received | 无 | 服务器接受的连接总数 | -| total_commands_processed | 无 | 服务器处理的命令总数 | -| instantaneous_ops_per_sec | 无 | 每秒处理的命令数 | -| total_net_input_bytes | byte | 从网络读取的字节总数 | -| total_net_output_bytes | byte | 写入网络的总字节数 | -| instantaneous_input_kbps | KB/S | 网络每秒的读取速率（KB/秒） | -| instantaneous_output_kbps | KB/S | 网络每秒的写入速率（KB/秒） | -| rejected_connections | 无 | 由于maxclients限制而拒绝的连接数 | -| sync_full | 无 | 具有副本的完整重新同步数 | -| sync_partial_ok | 无 | 接受的部分重新同步请求数 | -| sync_partial_err | 无 | 被拒绝的部分重新同步请求数 | -| expired_keys | 无 | 过期的key总数 | -| expired_stale_perc | 无 | 可能过期key的百分比 | -| expired_time_cap_reached_count | 无 | 活动过期周期提前停止的次数 | -| expire_cycle_cpu_milliseconds | 无 | 活动到期周期所花费的累计时间 | -| evicted_keys | 无 | 由于最大内存限制而收回key的数量 | -| keyspace_hits | 无 | 在主dict 中成功查找key的次数 | -| keyspace_misses | 无 | 在主dict 中未查到key的次数 | -| pubsub_channels | 无 | 客户端使用 pub/sub 频道的总和 | -| pubsub_patterns | 无 | 客户端使用 pub/sub 模式的全局数量 | -| latest_fork_usec | 无 | 最后一次fork操作的持续时间（以微秒为单位） | -| total_forks | 无 | 自服务器启动以来的fork操作总数 | -| migrate_cached_sockets | 无 | 为MIGRATE目的打开的socket数量 | -| slave_expires_tracked_keys | 无 | trace key 到期的数量（仅适用于可写副本） | -| active_defrag_hits | 无 | 主动碎片整理命中次数 | -| active_defrag_misses | 无 | 主动碎片整理未命中次数 | -| active_defrag_key_hits | 无 | 主动碎片整理key命中次数 | -| active_defrag_key_misses | 无 | 主动碎片整理key未命中次数 | -| tracking_total_keys | 无 | key 查询的总数 | -| tracking_total_items | 无 | item查询的总数 | -| tracking_total_prefixes | 无 | 前缀查询的总数 | -| unexpected_error_replies | 无 | 意外错误回复数，即AOF加载或复制中的错误类型 | -| total_error_replies | 无 | 发出的错误回复总数，即被拒绝的命令（命令执行之前的错误）和失败的命令（在命令执行过程中的错误）的总和 | -| dump_payload_sanitizations | 无 | 参考sanitize-dump-payload配置 | -| total_reads_processed | 无 | 正在读取的请求数 | -| total_writes_processed | 无 | 正在写入的请求数 | -| io_threaded_reads_processed | 无 | 正在读取的线程数 | -| io_threaded_writes_processed | 无 | 正在写入的线程数 | - -#### 指标集合：replication - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------------|------|-------------------------------------------------------------------------------------| -| role | 无 | 节点角色 master 主节点 slave 从节点 | -| connected_slaves | 无 | 连接的从节点数 | -| master_failover_state | 无 | 正在进行的故障切换的状态（如果有） | -| master_replid | 无 | 实例启动的随机字符串 | -| master_replid2 | 无 | 故障切换后用于PSYNC的辅助复制ID | -| master_repl_offset | 无 | 主从同步偏移量 | -| second_repl_offset | 无 | 接受从服务ID的最大偏移量 | -| repl_backlog_active | 无 | 表示从服务挤压处于活动状态 | -| repl_backlog_size | byte | 从服务积压缓冲区的总大小（字节） | -| repl_backlog_first_byte_offset | 无 | 复制缓冲区里偏移量的大小 | -| repl_backlog_histlen | 无 | 此值等于 master_repl_offset - repl_backlog_first_byte_offset,该值不会超过repl_backlog_size的大小 | - -#### 指标集合：cpu - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------|------|------------------------| -| used_cpu_sys | 无 | Redis主进程在内核态所占用CPU时钟总和 | -| used_cpu_user | 无 | Redis主进程在用户态所占用CPU时钟总和 | -| used_cpu_sys_children | 无 | Redis子进程在内核态所占用CPU时钟总和 | -| used_cpu_user_children | 无 | Redis子进程在用户态所占用CPU时钟总和 | -| used_cpu_sys_main_thread | 无 | Redis服务器主线程消耗的内核CPU | -| used_cpu_user_main_thread | 无 | Redis服务器主线程消耗的用户CPU | - -#### 指标集合：errorstats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|------|-----------| -| errorstat_ERR | 无 | 错误累计出现的次数 | -| errorstat_MISCONF | 无 | | - -#### 指标集合：cluster - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|--------------------| -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是 | - -#### 指标集合：commandstats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|---------------------------------------------------------------------------------------------------------------------------| -| cmdstat_set | 无 | set命令的统计信息，calls: 累计调用该命令的次数；usec: 调用该命令的累计耗时,单位微秒；usec_per_call: 调用该命令的平均耗时；rejected_call: 拒绝执行的次数；failed_calls: 调用失败的次数 | -| cmdstat_get | 无 | get命令的统计信息 | -| cmdstat_setnx | 无 | setnx命令的统计信息 | -| cmdstat_hset | 无 | hset命令的统计信息 | -| cmdstat_hget | 无 | hget命令的统计信息 | -| cmdstat_lpush | 无 | lpush命令的统计信息 | -| cmdstat_rpush | 无 | rpush命令的统计信息 | -| cmdstat_lpop | 无 | lpop命令的统计信息 | -| cmdstat_rpop | 无 | rpop命令的统计信息 | -| cmdstat_llen | 无 | llen命令的统计信息 | diff --git a/home/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 deleted file mode 100644 index 87bb81b7800..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -id: shenyu -title: 监控 Apache ShenYu API网关 -sidebar_label: ShenYu网关监控 -keywords: [开源监控系统, 开源消息中间件监控, ShenYu网关监控监控] ---- - -> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 - -## 监控前操作 - -您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 - -开启插件, 参考 [官方文档](https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin) - -主要如下两步骤: - -1. 在网关的 pom.xml 文件中添加 metrics 的依赖。 - -```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - -``` - -2. 在网关的配置yaml文件中编辑如下内容： - -```yaml -shenyu: - metrics: - enabled: true #设置为 true 表示开启 - name : prometheus - host: 127.0.0.1 #暴露的ip - port: 8090 #暴露的端口 - jmxConfig: #jmx配置 - props: - jvm_enabled: true #开启jvm的监控指标 -``` - -最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网关指标接口对外提供的端口，默认为8090。 | -| 超时时间 | HTTP请求响应超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：shenyu_request_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-------------------| -| value | 无 | 收集ShenYu网关的所有请求数量 | - -#### 指标集合：shenyu_request_throw_created - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-------------------| -| value | 无 | 收集ShenYu网关的异常请求数量 | - -#### 指标集合：process_cpu_seconds_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------| -| value | 无 | 用户和系统CPU总计所用的秒数 | - -#### 指标集合：process_open_fds - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-------------| -| value | 无 | 打开的文件描述符的数量 | - -#### 指标集合：process_max_fds - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------| -| value | 无 | 打开的文件描述符的最大数量 | - -#### 指标集合：jvm_info - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|----------| -| runtime | 无 | JVM 版本信息 | -| vendor | 无 | JVM 版本信息 | -| version | 无 | JVM 版本信息 | - -#### 指标集合：jvm_memory_bytes_used - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------| -| area | 无 | JVM 内存区域 | -| value | MB | 给定 JVM 内存区域的已用大小 | - -#### 指标集合：jvm_memory_pool_bytes_used - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已用大小 | - -#### 指标集合：jvm_memory_pool_bytes_committed - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已提交大小 | - -#### 指标集合：jvm_memory_pool_bytes_max - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的最大大小 | - -#### 指标集合：jvm_threads_state - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-------------| -| 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 deleted file mode 100644 index 73e9af9ee13..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: smtp -title: SMTP 邮件服务器监控 -sidebar_label: SMTP 监控 -keywords: [ open source monitoring tool, open source SMTP monitoring tool, monitoring SMTP metrics ] ---- - -> 收集和监控 SMTP 邮件服务器的常规性能指标。 - -```text -通过 SMTP 的 hello 命令确定服务器是否可用 -``` - -> 详见 - -**协议使用：SMTP** - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|---------|---------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️无需协议头（例如：https://、http://） | -| 监控名称 | 标识此监控的名称。名称需要保持唯一 | -| 端口 | SMTP 提供的端口号 | -| 电子邮件 | 您的电子邮件名称，用于 hello 命令的参数 | -| 超时时间 | 允许的收集响应时间 | -| 收集间隔 | 监视定期数据收集的间隔时间，单位：秒，最小可设置的间隔为 30 秒 | -| 是否检测可用性 | 是否在添加监控之前检测和验证监控的可用性。只有在检测成功后，才会继续进行添加和修改操作 | -| 描述备注 | 用于标识和描述此监控的更多信息，用户可以在此处添加备注信息 | - -### 收集的指标 - -#### 指标集：概要 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|-------------------| -| 响应时间 | 毫秒 | SMTP 服务器响应请求所需的时间 | -| 响应状态 | | 响应状态 | -| SMTP 服务器标语 | | SMTP 服务器的标语 | -| helo 命令返回信息 | | helo 命令返回的响应信息 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md deleted file mode 100644 index aaba0dd9841..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: spring_gateway -Title: 监控 Spring Gateway -sidebar_label: Spring Gateway -keywords: [开源监控工具, 开源 Spring Gateway 监控工具, 监控 Spring Gateway 指标] ---- - -> 收集和监控 SpringBoot Actuator 提供的常规性能指标。 - -## 监控前操作 - -如果您想使用此监控类型监控 'Spring Gateway' 的信息，您需要集成您的 SpringBoot 应用程序并启用 SpringBoot Actuator。 - -**1、添加 POM .XML 依赖:** - -```xml - - org.springframework.boot - spring-boot-starter-actuator - -``` - -**2. 修改 YML 配置以暴露度量接口:** - -```yaml -management: - endpoint: - gateway: - enabled: true # default value - endpoints: - web: - exposure: - include: '*' - enabled-by-default: on -``` - -### 配置参数 - -| 参数名称 | 参数描述 | -|----------|--------------------------------------------------------|-----------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 8080。 | -| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | - -### 采集指标 - -#### 指标收集: 健康状态 - -| 指标名称 | 指标单位 | 指标描述 | -|------|------|-------------------------| -| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | - -#### 指标收集: 环境信息 - -| 指标名称 | 指标单位 | 指标描述 | -|---------|------|----------------------------------------------| -| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | -| 端口号 | 无 | 应用程序暴露的端口 | -| 操作系统 | 无 | 运行操作系统 | -| 操作系统架构 | 无 | 运行操作系统的架构 | -| JDK供应商 | 无 | JDK 供应商 | -| JVM版本 | 无 | JVM 版本 | - -#### 指标收集: 线程信息 - -| 指标名称 | 指标单位 | 指标描述 | -|------|------|-------------| -| 状态 | 无 | 线程状态 | -| 数量 | 无 | 线程状态对应的线程数量 | - -#### 指标收集: 内存使用情况 - -| 指标名称 | 指标单位 | 指标描述 | -|------|------|------------| -| 内存空间 | 无 | 内存空间名称 | -| 内存占用 | MB | 此空间占用的内存大小 | - -#### 指标收集: 路由信息 - -| 指标名称 | 指标单位 | 指标描述 | -|-------|------|---------| -| 路由id | 无 | 路由 ID | -| 匹配规则 | 无 | 路由匹配规则 | -| 资源标识符 | 无 | 服务资源标识符 | -| 优先级 | 无 | 此路由的优先级 | diff --git a/home/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 deleted file mode 100644 index d39b67d3efd..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -id: springboot2 -title: 监控：SpringBoot2.0 监控 -sidebar_label: SpringBoot2.0 监控 -keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控] ---- - -> 对SpringBoot2.0 actuator 暴露的通用性能指标进行采集监控。 - -## 监控前操作 - -如果想要通过此监控类型监控 `SpringBoot` 中的信息，则需要您的SpringBoot应用集成并开启SpringBoot Actuator。 - -**1、添加POM.XML依赖：** - -```xml - - org.springframework.boot - spring-boot-starter-actuator - -``` - -**2、修改YML配置暴露指标接口：** - -```yaml -management: - endpoints: - web: - exposure: - include: '*' - enabled-by-default: on -``` - -*注意：如果你的项目里还引入了认证相关的依赖，比如springboot-security,那么SpringBoot Actuator暴露出的接口可能会被拦截，此时需要你手动放开这些接口，以springboot-security为例，需要在SecurityConfig配置类中加入以下代码：* - -```java -public class SecurityConfig extends WebSecurityConfigurerAdapter{ - @Override - protected void configure(HttpSecurity httpSecurity) throws Exception{ - httpSecurity - // 配置要放开的接口 ----------------------------------- - .antMatchers("/actuator/**").permitAll() - .antMatchers("/metrics/**").permitAll() - .antMatchers("/trace").permitAll() - .antMatchers("/heapdump").permitAll() - // 。。。 - // 其他接口请参考：https://blog.csdn.net/JHIII/article/details/126601858 ----------------------------------- - } -} -``` - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|-----------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：health - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-----------------| -| status | 无 | 服务健康状态: UP,Down | - -#### 指标集合：environment - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|----------------------------| -| profile | 无 | 应用运行profile: prod,dev,test | -| port | 无 | 应用暴露端口 | -| os | 无 | 运行所在操作系统 | -| os_arch | 无 | 运行所在操作系统架构 | -| jdk_vendor | 无 | jdk vendor | -| jvm_version | 无 | jvm version | - -#### 指标集合：threads - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|--------------| -| state | 无 | 线程状态 | -| number | 无 | 此线程状态对应的线程数量 | - -#### 指标集合：memory_used - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------|------|-----------| -| 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 deleted file mode 100644 index 847a7775adc..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: sqlserver -title: 监控：SqlServer数据库监控 -sidebar_label: SqlServer数据库 -keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] ---- - -> 对SqlServer数据库的通用性能指标进行采集监控。支持SqlServer 2017+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1433。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|--------------------------------------------------| -| machine_name | 无 | 运行服务器实例的 Windows 计算机名称 | -| server_name | 无 | 与Windows实例关联的服务器和实例信息SQL Server | -| version | 无 | 实例的版本，SQL Server，格式为"major.minor.build.revision" | -| edition | 无 | 已安装的 实例的产品SQL Server版本 | -| start_time | 无 | 数据库启动时间 | - -#### 指标集合：performance_counters - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------------------|------|-------------------------------------------------------------------------------------| -| database_pages | 无 | Database pages, 已获得的页面数(缓冲池) | -| target_pages | 无 | Target pages, 缓冲池必须的理想页面数 | -| page_life_expectancy | s,秒 | Page life expectancy, 数据页在缓冲池中驻留的时间，这个时间一般会大于 300 | -| buffer_cache_hit_ratio | % | Buffer cache hit ratio, 数据库缓冲池高速缓冲命中率，被请求的数据在缓冲池中被找到的概率，一般会大于 80% 才算正常，否则可能是缓冲池容量太小 | -| checkpoint_pages_sec | 无 | Checkpoint pages/sec, 检查点每秒写入磁盘的脏页个数，如果数据过高，证明缺少内存容量 | -| page_reads_sec | 无 | Page reads/sec, 缓存池中每秒读的页数 | -| page_writes_sec | 无 | Page writes/sec, 缓存池中每秒写的页数 | - -#### 指标集合：connection - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|---------| -| user_connection | 无 | 已连接的会话数 | - -### 常见问题 - -1. SSL连接问题修复 - -jdk版本：jdk11 -问题描述：SQL Server2019使用SA用户连接报错 -错误信息： - -```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:xxxxxxxxxxxxxxxxx -``` - -问题截图： -![issue](https://user-images.githubusercontent.com/38679717/206621658-c0741d48-673d-45ff-9a3b-47d113064c12.png) - -解决方案： -添加`SqlServer`监控时使用高级设置，自定义JDBC URL，拼接的jdbc url后面加上参数配置，```;encrypt=true;trustServerCertificate=true;```这个参数true表示无条件信任server端返回的任何根证书。 - -样例：```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` - -参考文档：[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) 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 deleted file mode 100644 index e15de6e3e97..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: ssl_cert -title: 监控：SSL证书监控 -sidebar_label: SSL证书监控 -keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] ---- - -> 对网站的SSL证书过期时间，响应时间等指标进行监测 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|-------------------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：certificate - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|----------| -| subject | 无 | 证书名称 | -| expired | 无 | 是否过期 | -| start_time | 无 | 有效期开始时间 | -| 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 deleted file mode 100644 index e1f112777f7..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: tomcat -title: 监控：Tomcat监控 -sidebar_label: Tomcat监控 -keywords: [开源监控系统, 开源网站监控, Tomcat监控] ---- - -> 对Tomcat的通用性能指标进行采集监控 - -**使用协议：JMX** - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：memory_pool - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：code_cache - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|--------| -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - -#### 指标集合：class_loading - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------|------|----------| -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - -#### 指标集合：thread - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------|------|-----------| -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - -### Tomcat开启JMX协议步骤 - -1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 - -2. vim catalina.sh - -```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/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 deleted file mode 100644 index 4425f1c2c06..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: ubuntu -title: 监控：Ubuntu操作系统监控 -sidebar_label: Ubuntu操作系统 -keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] ---- - -> 对Ubuntu操作系统的通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------|------|--------| -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | - -#### 指标集合：cpu - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|--------------------| -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | - -#### 指标集合：memory - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|----------| -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | - -#### 指标集合：disk - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|-----------| -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | - -#### 指标集合：interface - -| 指标名称 | 指标单位 | 指标帮助描述 | -|----------------|------|---------------| -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | - -#### 指标集合：disk_free - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|---------| -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| 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 deleted file mode 100644 index 7403f255aec..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: website -title: 监控：网站监测 -sidebar_label: 网站监测 -keywords: [开源监控系统, 开源网站监控] ---- - -> 对网站是否可用，响应时间等指标进行监测 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|---------|-------------------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：summary - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|--------| -| 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 deleted file mode 100644 index 0b1791435f4..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: windows -title: 监控：Windows操作系统监控 -sidebar_label: Windows操作系统 -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) -[Win配置SNMP中文](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|----------|----------------------------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Windows SNMP服务对外提供的端口，默认为 161。 | -| SNMP 版本 | SNMP协议版本 V1 V2c V3 | -| SNMP 团体字 | SNMP 协议团体名(Community Name)，用于实现SNMP网络管理员访问SNMP管理代理时的身份验证。类似于密码，默认值为 public | -| 超时时间 | 协议连接超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：system - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|--------| -| name | 无 | 主机名称 | -| descr | 无 | 操作系统描述 | -| uptime | 无 | 系统运行时间 | -| numUsers | 个数 | 当前用户数 | -| 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 deleted file mode 100644 index 9752c22bc4e..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: zookeeper -title: 监控：Zookeeper监控 -sidebar_label: Zookeeper监控 -keywords: [开源监控系统, Zookeeper监控监控] ---- - -> 对Zookeeper的通用性能指标进行采集监控 - -### 监控前操作 - -> 监控 zookeeper 目前的实现方案使用的是 zookeeper 提供的四字命令 + netcat 来收集指标数据 -> 需要用户自己将zookeeper的四字命令加入白名单 - -1. 加白名单步骤 - -> 1.找到我们 zookeeper 的配置文件，一般是 `zoo.cfg` -> -> 2.配置文件中加入以下命令 - -```shell -# 将需要的命令添加到白名单中 -4lw.commands.whitelist=stat, ruok, conf, isro - -# 将所有命令添加到白名单中 -4lw.commands.whitelist=* -``` - -> 3.重启服务 - -```shell -zkServer.sh restart -``` - -2. netcat 协议 - -目前实现方案需要我们部署zookeeper的linux服务器，安装netcat的命令环境 - -> netcat安装步骤 -> -> ```shell -> yum install -y nc -> ``` - -如果终端显示以下信息则说明安装成功 - -```shell -Complete! -``` - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Zookeeper的Linux服务器SSH端口。 | -| 查询超时时间 | 设置Zookeeper连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | Zookeeper所在Linux连接用户名 | -| 密码 | Zookeeper所在Linux连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：conf - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|------|----------------------------------------| -| clientPort | 无 | 端口 | -| dataDir | 无 | 数据快照文件目录，默认10万次操作生成一次快照 | -| dataDirSize | kb | 数据快照文件大小 | -| dataLogDir | 无 | 事务日志文件目录，生产环境放在独立磁盘上 | -| dataLogSize | kb | 事务日志文件大小 | -| tickTime | ms | 服务器之间或客户端与服务器之间维持心跳的时间间隔 | -| minSessionTimeout | ms | 最小session超时时间 心跳时间x2 指定时间小于该时间默认使用此时间 | -| maxSessionTimeout | ms | 最大session超时时间 心跳时间x20 指定时间大于该时间默认使用此时间 | -| serverId | 无 | 服务器编号 | - -#### 指标集合：stats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------------|------|------------| -| zk_version | 无 | 服务器版本 | -| zk_server_state | 无 | 服务器角色 | -| zk_num_alive_connections | 个 | 连接数 | -| zk_avg_latency | ms | 平均延时 | -| zk_outstanding_requests | 个 | 堆积请求数 | -| zk_znode_count | 个 | znode结点数量 | -| zk_packets_sent | 个 | 发包数 | -| zk_packets_received | 个 | 收包数 | -| zk_watch_count | 个 | watch数量 | -| zk_max_file_descriptor_count | 个 | 最大文件描述符数量 | -| zk_approximate_data_size | kb | 数据大小 | -| zk_open_file_descriptor_count | 个 | 打开的文件描述符数量 | -| 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 deleted file mode 100644 index e1184fcc2ab..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -id: introduce -title: HertzBeat赫兹跳动 -sidebar_label: 介绍 -slug: / ---- - -> 实时监控系统，无需Agent，性能集群，兼容Prometheus，自定义监控和状态页构建能力。 - -[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr) -[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/) -[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8139/badge)](https://www.bestpractices.dev/projects/8139) -[![Docker Pulls](https://img.shields.io/docker/pulls/apache/hertzbeat?style=%20for-the-badge&logo=docker&label=DockerHub%20Download)](https://hub.docker.com/r/apache/hertzbeat) -[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hertzbeat)](https://artifacthub.io/packages/search?repo=hertzbeat) -[![QQ](https://img.shields.io/badge/QQ-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) -[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) - -## 🎡 介绍 - -[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 - -### 特点 - -- 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控阈值告警通知一步到位。 -- 易用友好，无需 `Agent`，全 `WEB` 页面操作，鼠标点一点就能监控告警，零上手学习成本。 -- 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ -- 兼容 `Prometheus` 的系统生态并且更多，只需页面操作就可以监控 `Prometheus` 所能监控的。 -- 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 -- 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 -- 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 - -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 - ----- - -### 强大的监控模版 - -> 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 - -HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 -HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标数据。 - -![hertzbeat](/img/blog/multi-protocol.png) - -你相信用户只需在UI页面编写一个监控模版，点击保存后，就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ - -![hertzbeat](/img/home/9.png) - -### 内置监控类型 - -**官方内置了大量的监控模版类型，方便用户直接在页面添加使用，一款监控类型对应一个YML监控模版** - -- [Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), - [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), - [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), - [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), - [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) -- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), - [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) - [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), - [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) -- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), - [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), - [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), - [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), - [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) -- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), - [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), - [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), - [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) -- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) -- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), - [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), - [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) -- 和更多自定义监控模版。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱`。 - -### 强大自定义功能 - -> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 -> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 -> 模版里面包含各个协议的使用配置，环境变量，指标转换，指标计算，单位转换，指标采集等一系列功能，帮助用户能采集到自己想要的监控指标。 - -![hertzbeat](/img/docs/custom-arch.png) - -### 无需 Agent - -> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 -> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 -> `agent` 的版本是否与主应用兼容, `agent` 与主应用的通讯调试, `agent` 的同步升级等等等等，这些全是头大的点。 - -`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 - -- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 -- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 -**密码等敏感信息全链路加密** - -### 高性能集群 - -> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 - -- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 -- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 - -![hertzbeat](/img/docs/cluster-arch.png) - -### 云边协同 - -> 两地三中心，多云环境，多隔离网络，这些场景名词可能大家略有耳闻。当需要用一套监控系统统一监控不同隔离网络的IT资源时，这时我们的云边协同就来啦。 - -- `HertzBeat` 支持部署边缘采集器集群，与主 `HertzBeat` 服务云边协同提升采集能力。 - -在多个网络不相通的隔离网络中，在以往方案中我们需要在每个网络都部署一套监控系统，这导致数据不互通，管理部署维护都不方便。 -`HertzBeat` 提供的云边协同能力，可以在多个隔离网络部署边缘采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主服务统一调度管理展示。 - -![hertzbeat](/img/docs/cluster-arch.png) - -### 易用友好 - -- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 -- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 -- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 -- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 -- 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 - -### 完全开源 - -- Dromara开源社区顶级项目，Gitee GVP，使用`Apache2`协议，由自由开放的开源社区主导维护的开源协作产品。 -- 无监控数量`License`，监控类型等伪开源限制。 -- 基于`Java+SpringBoot+TypeScript+Angular`主流技术栈构建，方便的二次开发。 -- 开源不等同于免费，基于HertzBeat二次开发需保留logo，名称，页面脚注，版权等。 - -**HertzBeat 已被 [CNCF云原生全景图](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category) 收录** - -![cncf](/img/home/cncf-landscape-left-logo.svg) - ---- -**`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** - ------ - -## 即刻体验一波 - -Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` -浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` - -### 登陆页面 - -- HertzBeat 的用户管理统一由配置文件 `sureness.yml` 维护，用户可以通过修改此文件来新增删除修改用户信息，用户角色权限等。默认账户密码 admin/hertzbeat - -![hertzbeat](/img/home/0.png) - -### 概览页面 - -- 全局概览页面，分类展示了当前监控大类别数量分布，用户可直观查看当前的监控类型与数量并点击跳转至对应监控类型进行维护管理。 -- 展示当前注册的采集器集群状态，包括采集器的上线状态，监控任务，启动时间，IP地址，名称等。 -- 下发展示了最近告警信息列表，告警级别分布情况，告警处理率情况。 - -![hertzbeat](/img/home/1.png) - -### 监控中心 - -- 监控入口，支持对应用服务，数据库，操作系统，中间件，网络，自定义等监控的管理。 -- 以列表的形式展示当前已添加的监控，支持对监控的新增，修改，删除，取消监控，导入导出，批量管理等。 -- 支持标签分组，查询过滤，查看监控详情入口等。 - -内置支持的监控类型包括： - -- [Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), - [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), - [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), - [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), - [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) -- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), - [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) - [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), - [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) -- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), - [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), - [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), - [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), - [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) -- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), - [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), - [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), - [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) -- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) -- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), - [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), - [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) - -![hertzbeat](/img/home/2.png) - -### 新增修改监控 - -- 新增或修改指定监控类型的监控实例，配置对端监控的IP，端口等参数，设置采集周期，采集任务调度方式，支持提前探测可用性等。 -- 页面上配置的监控参数由对应监控类型的监控模版所定义，用户可以通过修改监控模版来修改页面配置参数。 -- 支持关联标签，用标签来管理监控分组，告警匹配等。 - -![hertzbeat](/img/home/10.png) - -### 监控详情 - -- 监控的数据详情页面，展示了当前监控的基本参数信息，监控指标数据信息。 -- 监控实时数据报告，以小卡片列表的形式展示了当前监控的所有指标实时值，用户可根据实时值参考配置告警阈值规则。 -- 监控历史数据报告，以趋势图表的形式展示了当前监控数值类型的指标的历史值，支持查询小时，天，月的历史数据，支持配置页面刷新时间。 -- ⚠️注意监控历史图表需配置外置时序数据库才能获取完整功能，时序数据库支持: IOTDB, TDengine, InfluxDB, GreptimeDB - -![hertzbeat](/img/home/3.png) - -![hertzbeat](/img/home/4.png) - -### 告警中心 - -- 已触发告警消息的管理展示页面，使用户有直观的展示当前告警情况。 -- 支持告警处理，告警标记未处理，告警删除清空等批量操作。 - -![hertzbeat](/img/home/7.png) - -### 阈值规则 - -- 对于监控的可用性状态设置阈值规则，特定指标的值超过我们预期范围时发出告警，这些都可以在阈值规则这里配置。 -- 告警级别分为三级：通知告警，严重告警，紧急告警。 -- 阈值规则支持可视化页面配置或表达式规则配置，灵活性更高。 -- 支持配置触发次数，告警级别，通知模版，关联指定监控等。 - -![hertzbeat](/img/home/6.png) - -![hertzbeat](/img/home/11.png) - -### 告警收敛 - -- 当通过阈值规则判断触发告警后，会进入到告警收敛，告警收敛会根据规则对特定时间段的重复告警消息去重收敛，已避免大量重复性告警导致接收人告警麻木。 -- 告警收敛规则支持重复告警生效时间段，标签匹配和告警级别匹配过滤。 - -![hertzbeat](/img/home/12.png) - -![hertzbeat](/img/home/13.png) - -### 告警静默 - -- 当通过阈值规则判断触发告警后，会进入到告警静默，告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默，此时间段不发送告警消息。 -- 此应用场景如用户在系统维护中，无需发已知告警。用户在工作日时间才会接收告警消息，用户在晚上需避免打扰等。 -- 告警静默规则支持一次性时间段或周期性时间段，支持标签匹配和告警级别匹配。 - -![hertzbeat](/img/home/14.png) - -![hertzbeat](/img/home/15.png) - -### 消息通知 - -- 消息通知功能是把告警消息通过不同媒体渠道通知给指定的接收人，告警消息及时触达。 -- 功能包含接收人信息管理和通知策略管理，接收人管理维护接收人信息以其通知方式信息，通知策略管理维护把哪些告警信息通知给哪些接收人的策略规则。 -- 通知方式支持 `邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式。 -- 通知策略支持标签匹配和告警级别匹配，方便的使不同标签的告警和告警级别分派给不同的接收处理人。 -- 支持通知模版，用户可以自定义通过模版内容格式来满足自己的个性化通知展示需求。 - -![hertzbeat](/img/home/16.png) - -![hertzbeat](/img/home/17.png) - -![hertzbeat](/img/home/8.png) - -### 监控模版 - -- HertzBeat 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ -- 同理我们内置的所有监控类型(mysql,website,jvm,k8s)也一一映射为对应的监控模版，用户可以新增修改监控模版来自定义监控功能。 - -![hertzbeat](/img/home/9.png) - ---- - -**还有更多强大的功能快去探索呀。Have Fun!** - ------ - -**官网: ** -**Github: ** -**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contact.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contact.md deleted file mode 100644 index 974009005cd..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contact.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: contact -title: 交流联系 -sidebar_label: 交流联系 ---- - -> 如果您在使用过程有任何需要帮助或者想交流建议，可以通过 群 ISSUE 讨论交流。 - -[GITHUB ISSUES](https://github.com/apache/hertzbeat/issues) - -[Chat On Discord](https://discord.gg/Fb6M73htGr) - -[Follow Us Twitter](https://twitter.com/hertzbeat1024) - -**微信交流群** 加微信号 ahertzbeat 邀请您进微信群。 - -**QQ交流群** 加QQ群号 630061200 - -##### Github Discussion - -[Github Discussion](https://github.com/apache/hertzbeat/discussions) 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 deleted file mode 100644 index 6913149bab1..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -id: contributing -title: 贡献者指南 -sidebar_label: 贡献者指南 ---- - -> 非常欢迎参与项目贡献，我们致力于维护一个互相帮助的快乐社区。 - -### 贡献方式 - -> 在 HertzBeat 社区，贡献方式有很多: - -- 💻**代码**：可以帮助社区完成一些任务、编写新的feature或者是修复一些bug； - -- ⚠️**测试**：可以来参与测试代码的编写，包括了单元测试、集成测试、e2e测试； - -- 📖**文档**：可以编写或完善文档，来帮助用户更好地了解和使用 HertzBeat； - -- 📝**博客**：可以撰写 HertzBeat 的相关文章，来帮助社区更好地推广； - -- 🤔**讨论**：可以参与 HertzBeat 新的feature的讨论，将您的想法跟 HertzBeat 融合； - -- 💡**布道**：可以帮助宣传或推广 HertzBeat 社区，在 meetup 或 summit 中演讲； - -- 💬**建议**：也可以对项目或者社区提出一些建议，促进社区的良性发展； - -更多贡献方式参见 [Contribution Types](https://allcontributors.org/docs/en/emoji-key) - -即便是小到错别字的修正我们也都非常欢迎 :) - -### 让 HertzBeat 运行起来 - -> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 -> 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 - -- 后端启动 - -1. 需要`maven3+`, `java11`和`lombok`环境 -2. (可选)修改配置文件配置信息-`manager/src/main/resources/application.yml` -3. 启动`springboot manager`服务 `manager/src/main/java/org/apache/hertzbeat/manager/Manager.java` - -- 前端启动 - -1. 需要`nodejs npm angular-cli`环境 -2. 安装yarn `npm install -g yarn` -3. 在前端工程目录web-app下执行 `yarn install` -4. 全局安装angular-cli `npm install -g @angular/cli@14 --registry=https://registry.npm.taobao.org` -5. 待本地后端启动后，在web-app目录下启动本地前端 `ng serve --open` -6. 浏览器访问 localhost:4200 即可开始，默认账号密码 admin/hertzbeat - -### 寻找任务 - -寻找您感兴趣的Issue！在我们的GitHub仓库和邮件列表中，我们经常会发布一些带有 good first issue 或者 status: volunteer wanted 标签的issue，这些issue都欢迎贡献者的帮助。 -其中good first issue往往门槛较低、适合新手。 - -当然，如果您有好的想法，也可以直接在GitHub Discussion 中提出或者联系社区。 - -### 提交 Pull Request - -1. 首先您需要 Fork 目标仓库 [hertzbeat repository](https://github.com/apache/hertzbeat). -2. 然后 用git命令 将代码下载到本地: - -```shell -git clone git@github.com:${YOUR_USERNAME}/hertzbeat.git #Recommended -``` - -3. 下载完成后，请参考目标仓库的入门指南或者 README 文件对项目进行初始化。 -4. 接着，您可以参考如下命令进行代码的提交, 切换新的分支, 进行开发: - -```shell -git checkout -b a-feature-branch #Recommended -``` - -5. 提交 commit , commit 描述信息需要符合约定格式: [module name or type name]feature or bugfix or doc: custom message. - -```shell -git add -git commit -m '[docs]feature: necessary instructions' #Recommended -``` - -6. 推送到远程仓库 - -```shell -git push origin a-feature-branch -``` - -7. 然后您就可以在 GitHub 上发起新的 PR (Pull Request)。 - -请注意 PR 的标题需要符合我们的规范，并且在 PR 中写上必要的说明，来方便 Committer 和其他贡献者进行代码审查。 - -### 等待PR代码被合并 - -在提交了 PR 后，Committer 或者社区的小伙伴们会对您提交的代码进行审查（Code Review），会提出一些修改建议，或者是进行一些讨论，请及时关注您的PR。 - -若后续需要改动，不需要发起一个新的 PR，在原有的分支上提交 commit 并推送到远程仓库后，PR会自动更新。 - -另外，我们的项目有比较规范和严格的 CI 检查流程，在提交 PR 之后会触发 CI，请注意是否通过 CI 检查。 - -最后，Committer 可以将 PR 合并入 master 主分支。 - -### 代码被合并后 - -在代码被合并后，您就可以在本地和远程仓库删除这个开发分支了： - -```shell -git branch -d a-dev-branch -git push origin --delete a-dev-branch -``` - -在主分支上，您可以执行以下操作来同步上游仓库： - -```shell -git remote add upstream https://github.com/apache/hertzbeat.git #Bind the remote warehouse, if it has been executed, it does not need to be executed again -git checkout master -git pull upstream master -``` - -### 如何成为Committer？ - -通过上述步骤，您就是 HertzBeat 的贡献者了。重复前面的步骤，在社区中保持活跃，坚持下去，您就能成为 Committer！ - -### 加入讨论交流 - -[Github Discussion](https://github.com/apache/hertzbeat/discussions) - -加微信号 `ahertzbeat` 拉您进微信交流群 - -### 模块 - -- **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务 - -> 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。 -> -> - **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 -> 使用通用协议远程采集获取对端指标数据。 -> - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 -> 采集指标结果数据管理，数据落盘，查询，计算统计。 -> - **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 -> 告警计算触发，任务状态联动，告警配置，告警通知。 -> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 -> 监控告警系统可视化控制台前端 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/design.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/design.md deleted file mode 100644 index 08bd383d97d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/design.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: design -title: 设计文档 -sidebar_label: 设计文档 ---- - -### HertzBeat架构 - -![architecture](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/docs/hertzbeat-arch.svg) - -### TanCloud架构 - -TanCloud是基于HertzBeat的公网SAAS集群版本，采用多集群，多租户的架构模式。 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 deleted file mode 100644 index 9492da3f9ca..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -id: developer -title: 开发者们 -sidebar_label: 开发者们 ---- - -## ✨ HertzBeat的成员们 - - - - - - - - - - - - - - - - - - - -
tomsun28
tomsun28
💻 📖 🎨		会编程的王学长
会编程的王学长
💻 📖 🎨		zcx
zcx
💻 🐛 🎨		进击的阿晨
进击的阿晨
💻 🎨 🐛		铁甲小宝
铁甲小宝
🐛 💻 📖		cuipiheqiuqiu
cuipiheqiuqiu
💻 ⚠️ 🎨		hudongdong129
hudongdong129
💻 ⚠️ 📖
zqr10159
Logic
📖 💻🎨		vinci
vinci
💻 📖 🎨		淞筱
淞筱
💻 📖 🎨		东风
东风
💻 🎨 📖
- -cert - -## ✨ HertzBeat的开发者们 - -Thanks these wonderful people, welcome to join us: [贡献者指南](contributing) - -cert - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tomsun28
tomsun28
💻 📖 🎨		会编程的王学长
会编程的王学长
💻 📖 🎨		MaxKey
MaxKey
💻 🎨 🤔		观沧海
观沧海
💻 🎨 🐛		yuye
yuye
💻 📖		jx10086
jx10086
💻 🐛		winnerTimer
winnerTimer
💻 🐛
goo-kits
goo-kits
💻 🐛		brave4Time
brave4Time
💻 🐛		WalkerLee
WalkerLee
💻 🐛		jianghang
jianghang
💻 🐛		ChineseTony
ChineseTony
💻 🐛		wyt199905
wyt199905
💻		卫傅庆
卫傅庆
💻 🐛
zklmcookle
zklmcookle
💻		DevilX5
DevilX5
📖 💻		tea
tea
💻		yangshihui
yangshihui
💻 🐛		DreamGirl524
DreamGirl524
💻 📖		gzwlly
gzwlly
📖		cuipiheqiuqiu
cuipiheqiuqiu
💻 ⚠️ 🎨
lambert
lambert
💻		mroldx
mroldx
📖		woshiniusange
woshiniusange
📖		VampireAchao
VampireAchao
💻		zcx
zcx
💻 🐛 🎨		CharlieXCL
CharlieXCL
📖		Privauto
Privauto
💻 📖
emrys
emrys
📖		SxLiuYu
SxLiuYu
🐛		All Contributors
All Contributors
📖		铁甲小宝
铁甲小宝
💻 📖		click33
click33
📖		蒋小小
蒋小小
📖		Kevin Huang
Kevin Huang
📖
铁甲小宝
铁甲小宝
🐛 💻 📖		Captain Jack
Captain Jack
📖		haibo.duan
haibo.duan
⚠️ 💻		assassin
assassin
🐛 💻		Reverse wind
Reverse wind
⚠️ 💻		luxx
luxx
💻		Ikko Ashimine
Ikko Ashimine
📖
leizenan
leizenan
💻		BKing
BKing
📖		xingshuaiLi
xingshuaiLi
📖		wangke6666
wangke6666
📖		刺猬
刺猬
🐛 💻		Haste
Haste
💻		zhongshi.yi
zhongshi.yi
📖
Qi Zhang
Qi Zhang
📖		MrAndyMing
MrAndyMing
📖		idongliming
idongliming
💻		Zichao Lin
Zichao Lin
💻 📖		liudonghua
liudonghua
💻 🤔		Jerry
Jerry
💻 ⚠️ 🤔		yanhom
yanhom
📖
fsl
fsl
💻		xttttv
xttttv
📖		NavinKumarBarnwal
NavinKumarBarnwal
💻		Zakkary
Zakkary
📖		sunxinbo
sunxinbo
💻 ⚠️		ldzbook
ldzbook
📖 🐛		余与雨
余与雨
💻 ⚠️
MysticalDream
MysticalDream
💻 ⚠️		zhouyoulin12
zhouyoulin12
💻 ⚠️		jerjjj
jerjjj
💻		wjl110
wjl110
💻		Sean
Sean
📖		chenyiqin
chenyiqin
💻 ⚠️		hudongdong129
hudongdong129
💻 ⚠️ 📖
TherChenYang
TherChenYang
💻 ⚠️		HattoriHenzo
HattoriHenzo
💻 ⚠️		ycilry
ycilry
📖		aoshiguchen
aoshiguchen
📖 💻		蔡本祥
蔡本祥
💻		浮游
浮游
💻		Grass-Life
Grass-Life
💻
xiaohe428
xiaohe428
💻 📖		TableRow
TableRow
📖 💻		ByteIDance
ByteIDance
💻		Jangfe
Jangfe
💻		zqr10159
zqr10159
📖 💻		vinci
vinci
💻 📖 🎨		js110
js110
💻
CrazyLionLi
CrazyLionLi
📖		banmajio
banmajio
💻		topsuder
topsuder
💻		richar2022
richar2022
💻		fcb-xiaobo
fcb-xiaobo
💻		wenkyzhang
wenkyzhang
📖		ZangJuxy
ZangJuxy
📖
l646505418
l646505418
💻		Carpe-Wang
Carpe-Wang
💻		莫枢
莫枢
💻		huangcanda
huangcanda
💻		世纪末的架构师
世纪末的架构师
💻		ShuningWan
ShuningWan
📖		MrYZhou
MrYZhou
📖
suncqujsj
suncqujsj
📖		sunqinbo
sunqinbo
💻		haoww
haoww
📖		i-mayuan
i-mayuan
📖		fengruge
fengruge
📖		zhanghuan
zhanghuan
💻		shenymin
shenymin
💻
Dhruva Chandra
Dhruva Chandra
💻		miss_z
miss_z
📖		wyt990
wyt990
💻		licocon
licocon
💻		Mi Na
Mi Na
💻		Kylin-Guo
Kylin-Guo
📖		Mr灬Dong先生
Mr灬Dong先生
💻
Pratyay Banerjee
Pratyay Banerjee
📖 💻		yujianzhong520
yujianzhong520
💻		SPPan
SPPan
💻		ZhangJiashu
ZhangJiashu
💻		impress
impress
💻		凌晨一点半
凌晨一点半
📖		Eeshaan Sawant
Eeshaan Sawant
💻
nandofromthebando
nandofromthebando
💻		caiboking
caiboking
💻		baixing99
baixing99
💻		Yang Chuang
Yang Chuang
💻		wlin20
wlin20
💻		guojing1983
guojing1983
💻		moxi
moxi
📖
qq471754603
qq471754603
💻		渭雨
渭雨
💻		liuxuezhuo
liuxuezhuo
💻		lisongning
lisongning
💻		YutingNie
YutingNie
💻 📖 🎨		Mike Zhou
Mike Zhou
💻 📖 🎨		小笨蛋
小笨蛋
💻
littlezhongzer
littlezhongzer
💻		ChenXiangxxxxx
ChenXiangxxxxx
💻		Mr.zhou
Mr.zhou
💻		姚贤丰
姚贤丰
💻		lingluojun
lingluojun
💻		1ue
1ue
💻		qyaaaa
qyaaaa
💻
novohit
novohit
💻		zhuoshangyi
zhuoshangyi
💻		ruanliang
ruanliang
📖 💻		Eden4701
Eden4701
💻 📖 🎨		XiaTian688
XiaTian688
📖		liyinjiang
liyinjiang
💻		ZhangJiashu
ZhangJiashu
📖
moghn
moghn
📖		xiaoguolong
xiaoguolong
💻		Smliexx
Smliexx
💻		Naruse
Naruse
📖 💻		Bala Sukesh
Bala Sukesh
💻		Jinyao Ma
Jinyao Ma
💻		Rick
Rick
💻 ⚠️
东风
东风
💻 🎨 📖		sonam singh
sonam singh
💻		ZhangZixuan1994
ZhangZixuan1994
💻		SHIG
SHIG
💻		泰上老菌
泰上老菌
💻		ldysdu
ldysdu
💻		梁同学
梁同学
💻
avv
avv
💻		yqxxgh
yqxxgh
📖		CharlieShi46
CharlieShi46
💻		Nctllnty
Nctllnty
💻		Wang-Yonghao
Wang-Yonghao
📖
- - - - 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 deleted file mode 100644 index bc2c4f50c96..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: huaweicloud -title: HertzBeat & HuaweiCloud -sidebar_label: HertzBeat & HuaweiCloud ---- - -### HertzBeat 与 HuaweiCloud 的开源合作需求Issue - -> 欢迎大家对感兴趣的Issue领取贡献。 - -- [Task] support using Huawei Cloud OBS to store custom define yml file [#841](https://github.com/apache/hertzbeat/issues/841) -- [Task] support Huawei Cloud CCE metrics monitoring [#839](https://github.com/apache/hertzbeat/issues/839) -- [Task] support EulerOS metrics monitoring [#838](https://github.com/apache/hertzbeat/issues/838) -- [Task] support using Huawei Cloud SMN send alarm notification message [#837](https://github.com/apache/hertzbeat/issues/837) -- [Task] support using GaussDB For Influx store history metrics data [#836](https://github.com/apache/hertzbeat/issues/836) - -### 关于 HuaweiCloud 开源活动 - -HuaweiCloud 华为云将面向开源软件工具链与环境、开源应用构建和开源生态组件构建这三大重点场景，提供技术支持、奖金支持、活动支持，邀请更多的开发者，携手构建开源for HuaweiCloud。 - -开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 - -感兴趣的开发者可以查看：华为云开源项目仓库 了解更多。 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 deleted file mode 100644 index 3cdc25e6196..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -id: images-deploy -title: HertzBeat 华为云镜像部署 -sidebar_label: HertzBeat 华为云镜像部署快速指引 ---- - -> 易用友好的开源实时监控告警工具，无需Agent，强大自定义监控能力。 - -[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr) -[![QQ](https://img.shields.io/badge/qq-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/web-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/ping-connect.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/port-available.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/database-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/os-monitor.svg) -![hertzbeat](https://img.shields.io/badge/monitor-cloud%20native-brightgreen) -![hertzbeat](https://img.shields.io/badge/monitor-middleware-blueviolet) -![hertzbeat](https://img.shields.io/badge/monitor-network-red) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/custom-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/alert.svg) - -## 🎡 介绍 - -> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警通知一步到位。 -> 更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 -> -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 -> 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ -> -> `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -> 当然我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**，中小团队和个人无需再为了监控自己的网站资源，而去部署学习一套繁琐的监控系统，**[登录即可免费开始](https://console.tancloud.cn)**。 - ----- - -![hertzbeat](/img/home/1.png) - -![hertzbeat](/img/home/9.png) - -## ⛄ Supported - -- [网站监控](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-website.yml), [端口可用性](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-api.yml), [Ping连通性](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap全站](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl证书](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP服务器](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ftp.yml) -- [Mysql](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mongodb.yml), - [达梦](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-iotdb.yml) -- [Linux](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-windows.yml) -- [Tomcat](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-activemq.yml) -- [Kubernetes](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-docker.yml) -- 和更多的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 - -## 镜像部署 - -> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 - -1. 开通服务器时选用 HertzBeat 镜像 -2. 启动服务器 -3. 配置HertzBeat的配置文件(可选) - - 修改位于 `/opt/hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件 - - 若需使用邮件发送告警，需替换`application.yml`里面的邮件服务器参数 - - **推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](../start/mysql-change)） - - **推荐**若需使用时序数据库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` 的配置文件实现，若无此需求可忽略此步骤 - 具体参考 [配置修改账户密码](../start/account-modify) - -5. 部署启动 - 执行位于安装目录/opt/hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - - ``` - ./startup.sh - ``` - -6. 开始探索HertzBeat - 浏览器访问 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 - -**HAVE FUN** - -### 部署常见问题 - -**最多的问题就是网络问题，请先提前排查** - -1. **按照流程部署，访问 无界面** - 请参考下面几点排查问题： - -> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 -> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 - -2. **监控历史图表长时间都一直无数据** - -> 一：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 deleted file mode 100644 index 8b712eb562f..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: resource -title: 相关资源 -sidebar_label: 相关资源 ---- - -## HertzBeat PDF介绍文档 - -下载: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf) - -## 图标资源 - -### HertzBeat LOGO - -![logo](/img/hertzbeat-logo.svg) - -下载: [SVG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.svg) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.png) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.jpg) - -### HertzBeat Brand LOGO - -![logo](/img/hertzbeat-brand.svg) - -下载: [SVG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-brand.svg) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-brand.png) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-brand.png) diff --git a/home/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 deleted file mode 100644 index 269c63417e6..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: sponsor -title: 赞助我们 -sidebar_label: 赞助我们 ---- - -**HertzBeat对个人或企业完全免费，我们也在全职做这件事情，如果您喜欢这个项目并且愿意提供帮助，请我们喝杯咖啡吧** - -planet - -感谢[吉实信息(构建全新的微波+光交易网络)](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 deleted file mode 100644 index decef8a5b5b..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -id: account-modify -title: 配置修改账户密码 -sidebar_label: 配置修改账户密码 ---- - -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 - -resourceRole: - - /api/account/auth/refresh===post===[admin,user,guest] - - /api/apps/**===get===[admin,user,guest] - - /api/monitor/**===get===[admin,user,guest] - - /api/monitor/**===post===[admin,user] - - /api/monitor/**===put===[admin,user] - - /api/monitor/**===delete==[admin] - - /api/monitors/**===get===[admin,user,guest] - - /api/monitors/**===post===[admin,user] - - /api/monitors/**===put===[admin,user] - - /api/monitors/**===delete===[admin] - - /api/alert/**===get===[admin,user,guest] - - /api/alert/**===post===[admin,user] - - /api/alert/**===put===[admin,user] - - /api/alert/**===delete===[admin] - - /api/alerts/**===get===[admin,user,guest] - - /api/alerts/**===post===[admin,user] - - /api/alerts/**===put===[admin,user] - - /api/alerts/**===delete===[admin] - - /api/notice/**===get===[admin,user,guest] - - /api/notice/**===post===[admin,user] - - /api/notice/**===put===[admin,user] - - /api/notice/**===delete===[admin] - - /api/tag/**===get===[admin,user,guest] - - /api/tag/**===post===[admin,user] - - /api/tag/**===put===[admin,user] - - /api/tag/**===delete===[admin] - - /api/summary/**===get===[admin,user,guest] - - /api/summary/**===post===[admin,user] - - /api/summary/**===put===[admin,user] - - /api/summary/**===delete===[admin] - -# 需要被过滤保护的资源,不认证鉴权直接访问 -# /api/v1/source3===get 表示 /api/v1/source3===get 可以被任何人访问 无需登录认证鉴权 -excludedResource: - - /api/account/auth/**===* - - /api/i18n/**===get - - /api/apps/hierarchy===get - # web ui 前端静态资源 - - /===get - - /dashboard/**===get - - /monitors/**===get - - /alert/**===get - - /account/**===get - - /setting/**===get - - /passport/**===get - - /**/*.html===get - - /**/*.js===get - - /**/*.css===get - - /**/*.ico===get - - /**/*.ttf===get - - /**/*.png===get - - /**/*.gif===get - - /**/*.jpg===get - - /**/*.svg===get - - /**/*.json===get - # swagger ui 资源 - - /swagger-resources/**===get - - /v2/api-docs===get - - /v3/api-docs===get - -# 用户账户信息 -# 下面有 admin tom lili 三个账户 -# eg: admin 拥有[admin,user]角色,密码为hertzbeat -# eg: tom 拥有[user],密码为hertzbeat -# eg: lili 拥有[guest],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] -``` - -修改`sureness.yml`的如下**部分参数**：**[注意⚠️sureness配置的其它默认参数需保留]** - -```yaml - -# 用户账户信息 -# 下面有 admin tom lili 三个账户 -# eg: admin 拥有[admin,user]角色,密码为hertzbeat -# eg: tom 拥有[user],密码为hertzbeat -# eg: lili 拥有[guest],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] -``` - -## 更新安全密钥 - -> 此密钥为账户安全加密管理的密钥，需要更新为相同长度的你自定义密钥串。 - -更新 `config` 目录下的 `application.yml` 文件，修改 `sureness.jwt.secret` 参数为你自定义的相同长度的密钥串。 - -```yaml -sureness: - jwt: - secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx3sDJeFV643R - LnfKefTjsIfJLBa2YkhEqEGtcHDTNe4CU6+9 - 8tVt4bisXQ13rbN0oxhUZR73M6EByXIO+SV5 - dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' -``` - -**重启 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 deleted file mode 100644 index 95bedddc350..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: custom-config -title: 常见参数配置 -sidebar_label: 常见参数配置 ---- - -这里描述了如果配置短信服务器，内置可用性告警触发次数等。 - -**`hertzbeat`的配置文件`application.yml`** - -### 配置HertzBeat的配置文件 - -修改位于 `hertzbeat/config/application.yml` 的配置文件 -注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 -安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -1. 配置短信发送服务器 - -> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 - -在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) - -```yaml -common: - sms: - tencent: - secret-id: AKIDbQ4VhdMr89wDedFrIcgU2PaaMvOuBCzY - secret-key: PaXGl0ziY9UcWFjUyiFlCPMr77rLkJYlyA - app-id: 1435441637 - sign-name: 赫兹跳动 - template-id: 1343434 -``` - -1.1 腾讯云短信创建签名（sign-name） -![image](https://github.com/apache/hertzbeat/assets/40455946/3a4c287d-b23d-4398-8562-4894296af485) - -1.2 腾讯云短信创建正文模板（template-id） - -``` -监控:{1}，告警级别:{2}。内容:{3} -``` - -![image](https://github.com/apache/hertzbeat/assets/40455946/face71a6-46d5-452c-bed3-59d2a975afeb) - -1.3 腾讯云短信创建应用（app-id） -![image](https://github.com/apache/hertzbeat/assets/40455946/2732d710-37fa-4455-af64-48bba273c2f8) - -1.4 腾讯云访问管理（secret-id、secret-key） -![image](https://github.com/apache/hertzbeat/assets/40455946/36f056f0-94e7-43db-8f07-82893c98024e) - -2. 配置告警自定义参数 - -```yaml -alerter: - # 自定义控制台地址 - console-url: https://console.tancloud.io -``` - -3. 使用外置redis代替内存存储实时指标数据 - -> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 - -注意⚠️ `memory.enabled: false, redis.enabled: true` - -```yaml -warehouse: - store: - memory: - enabled: false - init-size: 1024 - redis: - enabled: true - host: 127.0.0.1 - 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 deleted file mode 100644 index 1a042ae672e..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -id: docker-deploy -title: 通过 Docker 方式安装 HertzBeat -sidebar_label: Docker方式部署 ---- - -> 推荐使用Docker部署HertzBeat - -1. 下载安装Docker环境 - Docker 工具自身的下载请参考以下资料： - [Docker官网文档](https://docs.docker.com/get-docker/) - [菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html) - 安装完毕后终端查看Docker版本是否正常输出。 - - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -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 - ``` - - 若网络超时或者使用 - - ```shell - docker pull quay.io/tancloud/hertzbeat - docker pull quay.io/tancloud/hertzbeat-collector - ``` - -3. 部署HertzBeat您可能需要掌握的几条命令 - - ```shell - #查看所有容器(在运行和已经停止运行的容器) - $ docker ps -a - #启动/终止/重启/运行状态 - $ docker start/stop/restart/stats 容器id或者容器名 - #进入容器并打开容器的shell终端 - $ docker exec -it 容器id或者容器名 /bin/bash - #退出容器终端 - ctrl+p然后ctrl+q - #完全退出容器的终端 - ctrl+d或者 - $ exit - ``` - -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) - 具体修改步骤参考 [配置修改账户密码](account-modify) -6. 启动HertzBeat Docker容器 - -```shell -$ docker run -d -p 1157:1157 -p 1158:1158 \ - -e LANG=zh_CN.UTF-8 \ - -e TZ=Asia/Shanghai \ - -v $(pwd)/data:/opt/hertzbeat/data \ - -v $(pwd)/logs:/opt/hertzbeat/logs \ - -v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \ - -v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml \ - --restart=always \ - --name hertzbeat apache/hertzbeat -``` - - 这条命令启动一个运行HertzBeat的Docker容器，并且将容器的1157端口映射到宿主机的1157端口上。若宿主机已有进程占用该端口，则需要修改主机映射端口。 - -- `docker run -d` : 通过Docker运行一个容器,使其在后台运行 -- `-e LANG=zh_CN.UTF-8` : 设置系统语言 -- `-e TZ=Asia/Shanghai` : 设置系统时区 -- `-p 1157:1157 -p 1158:1158` : 映射容器端口到主机端口，请注意，前面是宿主机的端口号，后面是容器的端口号。1157是WEB端口，1158是集群端口。 -- `-v $(pwd)/data:/opt/hertzbeat/data` : (可选，数据持久化)重要⚠️ 挂载H2数据库文件到本地主机，保证数据不会因为容器的创建删除而丢失 -- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (可选，不需要可删除)挂载日志文件到本地主机，保证日志不会因为容器的创建删除而丢失，方便查看 -- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (可选,不需要可删除)挂载上上一步修改的本地配置文件到容器中，即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL，TDengine配置信息来连接外部服务。 -- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (可选,不需要可删除)挂载上一步修改的账户配置文件到容器中，若无修改账户需求可删除此命令参数。 -- 注意⚠️ 挂载文件时，前面参数为你自定义本地文件地址，后面参数为docker容器内文件地址(固定) -- `--name hertzbeat` : 命名容器名称 hertzbeat -- `--restart=always`：(可选，不需要可删除)使容器在Docker启动后自动重启。若您未在容器创建时指定该参数，可通过以下命令实现该容器自启。 - - ```shell - docker update --restart=always hertzbeat - ``` - -- `apache/hertzbeat` : 使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat`代替。** - -7. 开始探索HertzBeat - 浏览器访问 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 - -8. 部署采集器集群(可选) - -```shell -$ docker run -d \ - -e IDENTITY=custom-collector-name \ - -e MODE=public \ - -e MANAGER_HOST=127.0.0.1 \ - -e MANAGER_PORT=1158 \ - --name hertzbeat-collector apache/hertzbeat-collector -``` - -这条命令启动一个运行HertzBeat采集器的Docker容器，并直连上了HertzBeat主服务节点。 - -- `docker run -d` : 通过Docker运行一个容器,使其在后台运行 -- `-e IDENTITY=custom-collector-name` : (可选) 设置采集器的唯一标识名称。⚠️注意多采集器时采集器名称需保证唯一性。 -- `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。 -- `-e MANAGER_HOST=127.0.0.1` : 重要⚠️ 设置连接的主HertzBeat服务地址IP。 -- `-e MANAGER_PORT=1158` : (可选) 设置连接的主HertzBeat服务地址端口，默认 1158. -- `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (可选，不需要可删除)挂载日志文件到本地主机，保证日志不会因为容器的创建删除而丢失，方便查看 -- `--name hertzbeat-collector` : 命名容器名称 hertzbeat-collector -- `apache/hertzbeat-collector` : 使用拉取最新的的HertzBeat采集器官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat-collector`代替。** - -8. 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 - -**HAVE FUN** - -### Docker部署常见问题 - -**最多的问题就是网络问题，请先提前排查** - -1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** - 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 - -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` - -2. **按照流程部署，访问 无界面** - 请参考下面几点排查问题： - -> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 -> 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 - -3. **日志报错TDengine连接或插入SQL失败** - -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - -4. **监控历史图表长时间都一直无数据** - -> 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 -> 二：Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB或Tdengine IP账户密码等配置是否正确 - -5. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] - -> 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - -> 安装初始化此数据库参考 [TDengine安装初始化](tdengine-init) 或 [IoTDB安装初始化](iotdb-init) - -6. 安装配置了时序数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] - -> 请检查配置参数是否正确 -> 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 deleted file mode 100644 index 908e03e0702..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: greptime-init -title: 依赖时序数据库服务GreptimeDB安装初始化 -sidebar_label: 使用GreptimeDB存储指标数据(可选) ---- - -HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) -我们推荐使用并长期支持VictoriaMetrics - -GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. -It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage. - -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** - -### 通过Docker方式安装GreptimeDB - -> 可参考官方网站[安装教程](https://docs.greptime.com/getting-started/overview) -> -> 1. 下载安装Docker环境 -> Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 -> 安装完毕后终端查看Docker版本是否正常输出。 -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Docker安装GreptimeDB - -```shell -$ docker run -p 4000-4004:4000-4004 \ - -p 4242:4242 -v /opt/greptimedb:/tmp/greptimedb \ - --name greptime \ - greptime/greptimedb standalone start \ - --http-addr 0.0.0.0:4000 \ - --rpc-addr 0.0.0.0:4001 -``` - -`-v /opt/greptimedb:/tmp/greptimedb` 为greptimedb数据目录本地持久化挂载，需将`/opt/greptimedb`替换为实际本地存在的目录 -使用```$ docker ps```查看数据库是否启动成功 - -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 - -1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** - -```yaml -warehouse: - store: - # 关闭默认JPA - jpa: - enabled: false - greptime: - enabled: true - endpoint: localhost:4001 -``` - -2. 重启 HertzBeat - -### 常见问题 - -1. 时序数据库 GreptimeDB 或者 IoTDB 或者 TDengine 是否都需要配置，能不能都用 - -> 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md deleted file mode 100644 index fb144a25b08..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: influxdb-init -title: 依赖时序数据库服务InfluxDB安装初始化 -sidebar_label: 使用InfluxDB存储指标数据(可选) ---- - -HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) -我们推荐使用并长期支持VictoriaMetrics - -InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 - -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** - -### 1. 直接使用华为云服务 GaussDB For Influx - -> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) -> -> 获取云数据库对外暴露连接地址，账户密码即可 - -⚠️注意云数据库默认开启了SSL，云数据库地址应使用 `https:` - -### 2. 通过Docker方式安装InfluxDB - -> 可参考官方网站[安装教程](https://hub.docker.com/_/influxdb) -> -> 1. 下载安装Docker环境 -> Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 -> 安装完毕后终端查看Docker版本是否正常输出。 -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Docker安装InfluxDB 1.x - -```shell -$ docker run -p 8086:8086 \ - -v /opt/influxdb:/var/lib/influxdb \ - influxdb:1.8 -``` - -`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 -使用```$ docker ps```查看数据库是否启动成功 - -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 - -1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** - -```yaml -warehouse: - store: - # 关闭默认JPA - jpa: - enabled: false - influxdb: - enabled: true - server-url: http://localhost:8086 - username: root - password: root - expire-time: '30d' - replication: 1 -``` - -2. 重启 HertzBeat - -### 常见问题 - -1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 - -> 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md deleted file mode 100644 index 9a5e9e4c51e..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: iotdb-init -title: 依赖时序数据库服务IoTDB安装初始化 -sidebar_label: 使用IoTDB存储指标数据(可选) ---- - -HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) -我们推荐使用并长期支持VictoriaMetrics - -Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统，我们使用其存储分析采集到的监控指标历史数据。支持V0.12 - V0.13版本，推荐使用V0.13.*版本。 - -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** - -> 如果您已有IoTDB环境，可直接跳到YML配置那一步。 - -### 通过Docker方式安装IoTDB - -> 可参考官方网站[安装教程](https://iotdb.apache.org/zh/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) -> -> 1. 下载安装Docker环境 -> Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 -> 安装完毕后终端查看Docker版本是否正常输出。 -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Docker安装IoTDB - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - -`-v /opt/iotdb/data:/iotdb/data` 为IoTDB数据目录本地持久化挂载，需将`/iotdb/data`替换为实际本地存在的目录 -使用```$ docker ps```查看数据库是否启动成功 - -3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接 - - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.iot-db`数据源参数，HOST账户密码等，并启用`enabled`为`true`** - -```yaml -warehouse: - store: - # 关闭默认JPA - jpa: - enabled: false - # 启用IotDB - iot-db: - enabled: true - host: 127.0.0.1 - rpc-port: 6667 - username: root - password: root - # V_O_12 || V_0_13 - version: V_0_13 - # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 - query-timeout-in-ms: -1 - # 数据存储时间：默认'7776000000'（90天,单位为毫秒,-1代表永不过期） - expire-time: '7776000000' -``` - -4. 重启 HertzBeat - -### 常见问题 - -1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用 - -> 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - -2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] - -> 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 - -3. 安装配置了IotDB数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] - -> 请检查配置参数是否正确 -> iot-db enable是否设置为true -> 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP -> 可根据logs目录下启动日志排查 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md deleted file mode 100644 index ca028f18a63..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -id: mysql-change -title: 关系型数据库使用 Mysql 替换依赖的 H2 存储系统元数据 -sidebar_label: 元数据使用Mysql存储(可选) ---- - -MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 - -注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 - -> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 - -### 通过Docker方式安装MYSQL - -1. 下载安装Docker环境 - Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 - 安装完毕后终端查看Docker版本是否正常输出。 - - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -2. Docker安装MYSQl - - ``` - $ docker run -d --name mysql \ - -p 3306:3306 \ - -v /opt/data:/var/lib/mysql \ - -e MYSQL_ROOT_PASSWORD=123456 \ - --restart=always \ - mysql:5.7 - ``` - - `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 - -### 数据库创建 - -1. 进入MYSQL或使用客户端连接MYSQL服务 - `mysql -uroot -p123456` -2. 创建名称为hertzbeat的数据库 - `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` -3. 查看hertzbeat数据库是否创建成功 - `show databases;` - -### 修改hertzbeat的配置文件application.yml切换数据源 - -1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 - ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) - -需修改部分原参数: - -```yaml -spring: - datasource: - driver-class-name: org.h2.Driver - username: sa - password: 123456 - url: jdbc:h2:./data/hertzbeat;MODE=MYSQL -``` - -具体替换参数如下,需根据mysql环境配置账户密码IP: - -```yaml -spring: - datasource: - driver-class-name: com.mysql.cj.jdbc.Driver - username: root - password: 123456 - url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false -``` - -2. 通过docker启动时，需要修改host为宿主机的外网Ip，包括mysql连接字符串和redis。 - -**启动 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`异常， -需要在`application.yml`文件中增加以下配置： - -```yaml -spring: - jpa: - hibernate: - ddl-auto: update - properties: - hibernate: - dialect: org.hibernate.dialect.MySQL5InnoDBDialect -``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md deleted file mode 100644 index 09aa1e2de3f..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: package-deploy -title: 通过安装包安装 HertzBeat -sidebar_label: 安装包方式部署 ---- - -> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 - -1. 下载HertzBeat安装包 - 下载您系统环境对应的安装包 `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的配置文件(可选) - 解压安装包到主机 eg: /opt/hertzbeat - - ``` - $ tar zxvf hertzbeat-xx.tar.gz - or - $ unzip -o hertzbeat-xx.zip - ``` - - 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件 - - 若需使用邮件发送告警，需替换`application.yml`里面的邮件服务器参数 - - **推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)） - - **强烈推荐** 以后我们将主要支持VictoriaMetrics作为时序数据库，若需使用时序数据库VictoriaMetrics来存储指标数据，需替换`application.yml`里面的`warehouse.store.victoria-metrics`参数 具体步骤参见 [使用VictoriaMetrics存储指标数据](victoria-metrics-init) - - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) - - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) - -3. 配置用户配置文件(可选,自定义配置用户密码) - HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat - 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 - 具体参考 [配置修改账户密码](account-modify) - -4. 部署启动 - 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - - ``` - ./startup.sh - ``` - -5. 开始探索HertzBeat - 浏览器访问 即刻开始探索使用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` - - ```yaml - collector: - dispatch: - entrance: - netty: - enabled: true - identity: ${IDENTITY:} - mode: ${MODE:public} - manager-host: ${MANAGER_HOST:127.0.0.1} - manager-port: ${MANAGER_PORT:1158} - ``` - - - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 - -**HAVE FUN** - -### 安装包部署常见问题 - -**最多的问题就是网络环境问题，请先提前排查** - -1. **若您使用的是不含JDK的安装包，需您提前准备JAVA运行环境** - -安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) -要求：JAVA11环境 -下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) -安装后命令行检查是否成功安装 - -``` -$ java -version -java version "11.0.12" -Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) -Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) - -``` - -2. **按照流程部署，访问 无界面** - 请参考下面几点排查问题： - -> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 -> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 - -3. **日志报错TDengine连接或插入SQL失败** - -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - -4. **监控历史图表长时间都一直无数据** - -> 一：时序数据库是否配置，未配置则无历史图表数据 -> 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md deleted file mode 100644 index f3b30ac066d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: postgresql-change -title: 关系型数据库使用 PostgreSQL 替换依赖的 H2 存储系统元数据 -sidebar_label: 元数据使用PostgreSQL存储(可选) ---- - -PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBMS）。HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用PostgreSQL存储监控信息，告警信息，配置信息等结构化关系数据。 - -注意⚠️ 使用外置PostgreSQL数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 - -> 如果您已有PostgreSQL环境，可直接跳到数据库创建那一步。 - -### 通过Docker方式安装PostgreSQL - -1. Download and install the Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 - After the installation you can check if the Docker version normally output at the terminal. - - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -2. Docker安装 PostgreSQL - - ``` - docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 - ``` - - 使用```$ docker ps```查看数据库是否启动成功 - -3. Create database in container manually or with [script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-iotdb/conf/sql/schema.sql). - -### 数据库创建 - -1. 进入 PostgreSQL 或使用客户端连接 PostgreSQL 服务 - - ``` - su - postgres - psql - ``` - -2. 创建名称为hertzbeat的数据库 - `CREATE DATABASE hertzbeat;` -3. 查看hertzbeat数据库是否创建成功 - `\l` - -### 修改hertzbeat的配置文件application.yml切换数据源 - -1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 - ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) - -```yaml -spring: - datasource: - driver-class-name: org.h2.Driver - username: sa - password: 123456 - url: jdbc:h2:./data/hertzbeat;MODE=MYSQL -``` - -具体替换参数如下,需根据 PostgreSQL 环境配置账户密码IP: - -```yaml -spring: - config: - activate: - on-profile: prod - datasource: - driver-class-name: org.postgresql.Driver - username: root - password: 123456 - url: jdbc:postgresql://127.0.0.1:5432/hertzbeat - hikari: - max-lifetime: 120000 - - jpa: - database: postgresql - hibernate: - ddl-auto: update - properties: - hibernate: - dialect: org.hibernate.dialect.PostgreSQLDialect -``` - -**启动 HertzBeat 浏览器访问 开始使用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 deleted file mode 100644 index 21c956521a9..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -id: quickstart -title: 快速开始 -sidebar_label: 快速开始 ---- - -### 🐕 开始使用 - -- 如果您是想将HertzBeat部署到本地搭建监控系统，请参考下面的部署文档进行操作。 - -### 🍞 HertzBeat安装 - -> HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持X86/ARM64。 - -#### 方式一：Docker方式快速安装 - -1. `docker` 环境仅需一条命令即可开始 - -```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` - -```或者使用 quay.io (若 dockerhub 网络链接超时)``` - -```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` - -2. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` - -3. 部署采集器集群 - -``` -docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector -``` - -- `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。 -- `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。 -- `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 -- `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。 - -更多配置详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy) - -#### 方式二：通过安装包安装 - -1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [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` -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) - - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` - - ```yaml - collector: - dispatch: - entrance: - netty: - enabled: true - identity: ${IDENTITY:} - mode: ${MODE:public} - manager-host: ${MANAGER_HOST:127.0.0.1} - manager-port: ${MANAGER_PORT:1158} - ``` - - - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 - -更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) - -#### 方式三：本地代码启动 - -1. 此为前后端分离项目，本地代码调试需要分别启动后端工程`manager`和前端工程`web-app` -2. 后端：需要`maven3+`, `java11`和`lombok`环境，修改`YML`配置信息并启动`manager`服务 -3. 前端：需要`nodejs npm angular-cli`环境，待本地后端启动后，在`web-app`目录下启动 `ng serve --open` -4. 浏览器访问 `http://localhost:4200` 即可开始，默认账号密码 `admin/hertzbeat` - -详细步骤参考 [参与贡献之本地代码启动](../others/contributing) - -##### 方式四：Docker-Compose 统一安装 hertzbeat+mysql+iotdb/tdengine - -通过 [docker-compose部署脚本](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) 一次性把 mysql 数据库, iotdb/tdengine 时序数据库和 hertzbeat 安装部署。 - -详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) - -##### 方式五：Kubernetes Helm Charts 部署 hertzbeat+collector+mysql+iotdb - -通过 Helm Chart 一次性将 HertzBeat 集群组件部署到 Kubernetes 集群中。 - -详细步骤参考 [Artifact Hub](https://artifacthub.io/packages/helm/hertzbeat/hertzbeat) - -**HAVE FUN** - -### 🐵 依赖服务部署(可选) - -> HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) - -**注意⚠️ 若需要部署时序数据库，IotDB 和 TDengine 任选其一即可！** - -##### 安装Mysql(可选) - -1. docker安装Mysql - `$ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7` - `-v /opt/data:/var/lib/mysql` - 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 -2. 创建名称为hertzbeat的数据库 - `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` -3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 - -详细步骤参考 [使用Mysql替换内置H2数据库](mysql-change) - -##### 安装TDengine(可选) - -1. docker安装TDengine - `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:3.0.4.0` -2. 创建名称为hertzbeat的数据库 -3. 在hertzbeat的配置文件`application.yml`配置tdengine连接 - -详细步骤参考 [使用时序数据库TDengine存储指标数据(可选)](tdengine-init) - -##### 安装IotDB(可选) - -1. Docker安装IoTDB - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - -详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/rainbond-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/rainbond-deploy.md deleted file mode 100644 index 83afd21fc92..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/rainbond-deploy.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: rainbond-deploy -title: 使用 Rainbond 部署 HertzBeat -sidebar_label: Rainbond方式部署 ---- - -如果你不熟悉 Kubernetes，想在 Kubernetes 中安装 HertzBeat，可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台，可以很简单的将你的应用部署到 Kubernetes中。 - -## 前提 - -安装 Rainbond，请参阅 [Rainbond 快速安装](https://www.rainbond.com/docs/quick-start/quick-install)。 - -## 部署 HertzBeat - -登录 Rainbond 后，点击左侧菜单中的 `应用市场`，切换到开源应用商店，在搜索框中搜索 `HertzBeat`，点击安装按钮。 - -![](/img/docs/start/install-to-rainbond.png) - -填写以下信息，然后点击确认按钮进行安装。 - -* 团队：选择现有团队或创建新的团队 -* 集群：选择对应的集群 -* 应用：选择现有应用或创建新的应用 -* 版本：选择要安装的 HertzBeat 版本 - -等待安装完成，即可访问 HertzBeat 应用。 - -![](/img/docs/start/hertzbeat-topology.png) - -:::tip -通过 Rainbond 安装的 HertzBeat，默认使用了外部的 Mysql 数据库 和 Redis 以及 IoTDB。同时也挂载了 HertzBeat 的配置文件，可以在 `组件 -> 环境配置 -> 配置文件设置` 中修改配置文件。 -::: 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 deleted file mode 100644 index 835c4625638..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -id: ssl-cert-practice -title: SSL证书过期监控使用案例 -sidebar_label: 使用案例 ---- - -现在大部分网站都默认支持 HTTPS，我们申请的证书一般是3个月或者1年，很容易随着时间的流逝SSL证书过期了我们却没有第一时间发现，或者在过期之前没有及时更新证书。 - -这篇文章介绍如果使用 hertzbeat 监控系统来检测我们网站的SSL证书有效期，当证书过期时或证书快过期前几天，给我们发告警消息。 - -#### HertzBeat是什么 - -HertzBeat 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 - -**官网: | ** - -github: -gitee: - -#### 安装 HertzBeat - -1.如果不想安装可以直接使用云服务 [TanCloud探云 console.tancloud.cn](https://console.tancloud.cn) - -2. `docker` 环境仅需一条命令即可安装 - -`docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` - -3. 安装成功浏览器访问 `localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` - -#### 监控SSL证书 - -1. 点击新增SSL证书监控 - -> 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书 - -![](/img/docs/start/ssl_1.png) - -2. 配置监控网站 - -> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 -> 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。 - -![](/img/docs/start/ssl_2.png) - -3. 查看检测指标数据 - -> 在监控列表可以查看任务状态，进监控详情可以查看指标数据图表等。 - -![](/img/docs/start/ssl_3.png) - -![](/img/docs/start/ssl_11.png) - -4. 设置阈值(证书过期时触发) - -> 系统页面 -> 告警 -> 告警阈值 -> 新增阈值 - -![](/img/docs/start/ssl_4.png) - -> 配置阈值，选择SSL证书指标对象，配置告警表达式-当指标`expired`为`true`触发，即`equals(expired,"true")` , 设置告警级别通知模版信息等。 - -![](/img/docs/start/ssl_5.png) - -> 关联阈值与监控, 在阈值列表设置此阈值应用于哪些监控。 - -![](/img/docs/start/ssl_6.png) - -5. 设置阈值(证书过期前一周触发) - -> 同理如上，新增配置阈值，配置告警表达式-当指标有效期时间戳 `end_timestamp`，`now()`函数为当前时间戳，若配置提前一周触发告警即：`end_timestamp <= (now() + 604800000)` , 其中 `604800000` 为7天总时间差毫秒值。 - -![](/img/docs/start/ssl_7.png) - -> 最终可以在告警中心看到已触发的告警。 - -![](/img/docs/start/ssl_8.png) - -6. 告警通知(通过钉钉微信飞书等及时通知) - -> 监控系统 -> 告警通知 -> 新增接收人 - -![](/img/docs/start/ssl_9.png) - -钉钉微信飞书等token配置可以参考帮助文档 - - - - -> 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 - -![](/img/docs/start/ssl_10.png) - -7. OK 当阈值触发后我们就可以收到对应告警消息啦，如果没有配通知，也可以在告警中心查看告警信息。 - ----- - -#### 完 - -监控SSL证书的实践就到这里，当然对hertzbeat来说这个功能只是冰山一角，如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ - -**github: ** - -**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 deleted file mode 100644 index 757cb363256..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: tdengine-init -title: 依赖时序数据库服务TDengine安装初始化 -sidebar_label: 使用TDengine存储指标数据(可选) ---- - -HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) -我们推荐使用并长期支持VictoriaMetrics - -TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 - -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** - -> 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 - -### 通过Docker方式安装TDengine - -> 可参考官方网站[安装教程](https://docs.taosdata.com/get-started/docker/) -> -> 1. 下载安装Docker环境 -> Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 -> 安装完毕后终端查看Docker版本是否正常输出。 -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Docker安装TDengine - -```shell -$ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ - -v /opt/taosdata:/var/lib/taos \ - --name tdengine -e TZ=Asia/Shanghai \ - tdengine/tdengine:3.0.4.0 -``` - -`-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 -`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 -使用```$ docker ps```查看数据库是否启动成功 - -### 创建数据库实例 - -> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) - -1. 进入数据库Docker容器 - - ``` - docker exec -it tdengine /bin/bash - ``` - -2. 修改账户密码 - - > 建议您修改密码。TDengine默认的账户密码是 root/taosdata - > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: - - ``` - root@tdengine-server:~/TDengine-server# taos - Welcome to the TDengine shell from Linux, Client Version - Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. - taos> - ``` - - > 在 TDengine CLI 中使用 alter user 命令可以修改用户密码，缺省密码为 taosdata - -3. 创建名称为hertzbeat的数据库 - - 执行创建数据库命令 - - ``` - taos> show databases; - taos> CREATE DATABASE hertzbeat KEEP 90 DURATION 10 BUFFER 16; - ``` - - 上述语句将创建一个名为 hertzbeat 的库，这个库的数据将保留90天（超过90天将被自动删除），每 10 天一个数据文件，每个 VNode 的写入内存池的大小为 16 MB - -4. 查看hertzbeat数据库是否成功创建 - - ``` - taos> show databases; - taos> use hertzbeat; - ``` - -5. 退出TDengine CLI - - ``` - 输入 q 或 quit 或 exit 回车 - ``` - -**注意⚠️若是安装包安装的TDengine** - -> 除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 - -1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** - -```yaml -warehouse: - store: - # 关闭默认JPA - jpa: - enabled: false - td-engine: - enabled: true - driver-class-name: com.taosdata.jdbc.rs.RestfulDriver - url: jdbc:TAOS-RS://localhost:6041/hertzbeat - username: root - password: taosdata -``` - -2. 重启 HertzBeat - -### 常见问题 - -1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用 - -> 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - -2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] - -> 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 - -3. 监控详情历史图片不展示或无数据，已经配置了TDengine - -> 请确认是否安装的TDengine版本为3.0以上，版本2.x不支持兼容 - -4. 安装配置了TDengine数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] - -> 请检查配置参数是否正确 -> 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/upgrade.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/upgrade.md deleted file mode 100644 index ed85c460e76..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/upgrade.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: upgrade -title: HertzBeat 新版本更新指引 -sidebar_label: 版本更新指引 ---- - -**HertzBeat 的发布版本列表** - -- [Download](https://hertzbeat.apache.org/docs/download) -- [Gitee Release](https://gitee.com/hertzbeat/hertzbeat/releases) -- [DockerHub Release](https://hub.docker.com/r/apache/hertzbeat/tags) -- [Docker quay.io Release](https://quay.io/repository/apache/hertzbeat?tab=tags) - -HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据库内, 采集指标数据存储在 TDengine, IotDB 等时序数据库内。 - -**升级前您需要保存备份好数据库的数据文件和监控模版文件** - -### Docker部署方式的升级 - -1. 若使用了自定义监控模版 - - 需要备份 `docker cp hertzbeat:/opt/hertzbeat/define ./define` 当前运行 docker 容器里面的 `/opt/hertzbeat/define` 目录到当前主机下 - - `docker cp hertzbeat:/opt/hertzbeat/define ./define` - - 然后在后续升级启动 docker 容器的时候需要挂载上这个 define 目录，`-v $(pwd)/define:/opt/hertzbeat/define` - - `-v $(pwd)/define:/opt/hertzbeat/define` -2. 若使用内置默认 H2 数据库 - - 需挂载或备份 `-v $(pwd)/data:/opt/hertzbeat/data` 容器内的数据库文件目录 `/opt/hertzbeat/data` - - 停止并删除容器，删除本地 HertzBeat docker 镜像，拉取新版本镜像 - - 参考 [Docker安装HertzBeat](docker-deploy) 使用新镜像创建新的容器，注意需要将数据库文件目录挂载 `-v $(pwd)/data:/opt/hertzbeat/data` -3. 若使用外置关系型数据库 Mysql, PostgreSQL - - 无需挂载备份容器内的数据库文件目录 - - 停止并删除容器，删除本地 HertzBeat docker 镜像，拉取新版本镜像 - - 参考 [Docker安装HertzBeat](docker-deploy) 使用新镜像创建新的容器，`application.yml`配置数据库连接即可 - -### 安装包部署方式的升级 - -1. 若使用内置默认 H2 数据库 - - 备份安装包下的数据库文件目录 `/opt/hertzbeat/data` - - 若有自定义监控模版，需备份 `/opt/hertzbeat/define` 下的模版YML - - `bin/shutdown.sh` 停止 HertzBeat 进程，下载新安装包 - - 参考 [安装包安装HertzBeat](package-deploy) 使用新安装包启动 -2. 若使用外置关系型数据库 Mysql, PostgreSQL - - 无需备份安装包下的数据库文件目录 - - 若有自定义监控模版，需备份 `/opt/hertzbeat/define` 下的模版YML - - `bin/shutdown.sh` 停止 HertzBeat 进程，下载新安装包 - - 参考 [安装包安装HertzBeat](package-deploy) 使用新安装包启动，`application.yml`配置数据库连接即可 - -**HAVE FUN** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.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 deleted file mode 100644 index 9b0bc7a6565..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: victoria-metrics-init -title: 依赖时序数据库服务VictoriaMetrics安装初始化 -sidebar_label: 使用VictoriaMetrics存储指标数据(推荐) ---- - -HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) -我们推荐使用并长期支持VictoriaMetrics - -VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) - -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** - -> 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 - -### 通过Docker方式安装VictoriaMetrics - -> 可参考官方网站[安装教程](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) -> -> 1. 下载安装Docker环境 -> Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 -> 安装完毕后终端查看Docker版本是否正常输出。 -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Docker安装VictoriaMetrics - -```shell -$ docker run -d -p 8428:8428 \ - -v $(pwd)/victoria-metrics-data:/victoria-metrics-data \ - --name victoria-metrics \ - victoriametrics/victoria-metrics:v1.95.1 -``` - -`-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 -使用```$ docker ps```查看数据库是否启动成功 - -3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 - - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** - -```yaml -warehouse: - store: - # 关闭默认JPA - jpa: - enabled: false - # 启用 victoria-metrics - victoria-metrics: - enabled: true - url: http://localhost:8428 - username: root - password: root -``` - -4. 重启 HertzBeat - -### 常见问题 - -1. 时序数据库是否都需要配置，能不能都用 - -> 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，但会影响历史图表数据和存储时长等。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md deleted file mode 100644 index 5002aa52f7d..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: template -title: 监控模版中心 -sidebar_label: 监控模版 ---- - -> Hertzbeat 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 -> 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ - -这是它的架构原理: - -![hertzBeat](/img/docs/hertzbeat-arch.png) - -**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版，用户可以导入这些模版到hertzbeat系统中，使其支持对应类型的监控，非常方便！** - -![](/img/docs/advanced/extend-point-1.png) - -**欢迎大家一起贡献你使用过程中自定义的通用监控类型YML模版，可用的模板如下:** - -### 应用服务监控模版 - - 👉 [Website monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml)
- 👉 [HTTP API](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml)
- 👉 [PING Connectivity](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml)
- 👉 [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml)
- 👉 [Full site monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml)
- 👉 [SSL Cert monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml)
- 👉 [JVM monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml)
- 👉 [SpringBoot2.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml)
- 👉 [SpringBoot3.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml)
- 👉 [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml)
- -### 数据库监控模版 - - 👉 [MYSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml)
- 👉 [MariaDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml)
- 👉 [PostgreSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml)
- 👉 [SqlServer database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml)
- 👉 [Oracle database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml)
- 👉 [DM database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml)
- 👉 [OpenGauss database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml)
- 👉 [IoTDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml)
- 👉 [ElasticSearch database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml)
- 👉 [MongoDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml)
- 👉 [ClickHouse database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml)
- 👉 [Redis database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml)
- 👉 [Redis Sentinel database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml)
- 👉 [Redis Cluster database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml)
- -### 操作系统监控模版 - - 👉 [Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml)
- 👉 [Windows operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml)
- 👉 [Ubuntu operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml)
- 👉 [Centos operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml)
- 👉 [EulerOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml)
- 👉 [Fedora CoreOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml)
- 👉 [OpenSUSE operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml)
- 👉 [Rocky Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml)
- 👉 [Red Hat operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml)
- 👉 [FreeBSD operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml)
- 👉 [AlmaLinux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml)
- 👉 [Debian operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml)
- -### 中间件监控模版 - - 👉 [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml)
- 👉 [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml)
- 👉 [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml)
- 👉 [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml)
- 👉 [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml)
- 👉 [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml)
- 👉 [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml)
- 👉 [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml)
- 👉 [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml)
- 👉 [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml)
- -### 云原生监控模版 - - 👉 [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml)
- 👉 [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml)
- -### 网络监控模版 - - 👉 [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml)
- 👉 [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml)
- 👉 [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml)
- 👉 [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml)
- 👉 [H3CSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
- ---- - -**Have Fun!** diff --git a/home/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 5eabbc561ed..5402bc696aa 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 @@ -168,6 +168,8 @@ $ svn ci -m "add gpg key for muchunjin" ## 3. 准备物料 & 发布 +### 准备发布物料 + #### 3.1 基于 master 分支，创建一个名为 release-${release_version}-rcx 的分支，例如 release-1.6.0-rc1。并基于 release-1.6.0-rc1 分支创建一个名为 v1.6.0-rc1 的标签，并将此标签设置为预发布 ```shell @@ -228,6 +230,8 @@ release-1.6.0-rc1 生成的代码归档文件在 `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz` +### 签名发布物料 + #### 3.5 对二进制和源码包进行签名 将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。 @@ -335,7 +339,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" ## 4. 进入社区投票阶段 -#### 4.1 发送社区投票邮件 +### 4.1 发送社区投票邮件 发送社区投票邮件需要至少三个`+1`，且无`-1`。 @@ -426,7 +430,7 @@ ChunJin Mu 邮件内容中的一项是`Vote thread`，在 查看获取 -#### 3.2 发送孵化社区投票邮件 +### 3.2 发送孵化社区投票邮件 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。 @@ -529,13 +533,13 @@ ChunJin Mu ## 4. 完成最终发布步骤 -#### 4.1 迁移源代码和二进制包 +### 4.1 迁移源代码和二进制包 ```shell svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0 -m "transfer packages for 1.6.0-RC1" ``` -#### 4.2 添加新版本下载地址到官网 +### 4.2 添加新版本下载地址到官网 @@ -544,7 +548,7 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http > 需要注意的是，下载链接可能需要一个小时后才会生效，请注意。 -#### 4.3 Github 生成 Release +### 4.3 Github 生成 Release 基于 release-1.6.0-rc1 分支修改创建一个名为 v1.6.0 的标签，并将此标签设置为 latest release。 @@ -571,23 +575,29 @@ release note: xxx 然后将 release-1.6.0-rc1 分支重命名 为 release-1.6.0。 -#### 4.4 发送新版本公告邮件 +### 4.4 发送新版本公告邮件 > `Send to`:
> `cc`:
-> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0
+> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released
> `Body`: ``` -Hi Incubator Community, +Hi Community, We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. -Once again I would like to express my thanks to your help. +Thanks again for your help. + +Apache HertzBeat (https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +Download Link: +https://hertzbeat.apache.org/docs/download/ -Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +Release Note: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0 -Download Links: https://hertzbeat.apache.org/download/ -Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 +Website: +https://hertzbeat.apache.org/ HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues 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 386ec0e91e1..e012e347c20 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 @@ -5,7 +5,7 @@ sidebar_label: DNS服务器 keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] --- -# 监控：DNS服务器 +## 监控：DNS服务器 > 收集和监控DNS的常规性能指标。 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 4f0363f621d..cc4c7254afe 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 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 a160f2501e4..0806232cee5 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 @@ -7,7 +7,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito NTP监控的中文文档如下： -# NTP监控 +## NTP监控 > 收集和监控NTP的常规性能指标。 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 85756d3df46..07d5a8b8ed3 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 @@ -87,7 +87,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN **HAVE FUN** -### 🐵 依赖服务部署(可选) +#### 🐵 依赖服务部署(可选) > HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) 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 deleted file mode 100644 index 1030e382685..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -id: extend-http-default -title: HTTP Protocol System Default Parsing Method -sidebar_label: Default Parsing Method ---- - -> After calling the HTTP api to obtain the response data, use the default parsing method of hertzbeat to parse the response data. - -**The interface response data structure must be consistent with the data structure rules specified by hertzbeat** - -### HertzBeat data format specification - -Note⚠️ The response data is JSON format. - -Single layer format ：key-value - -```json -{ - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" -} -``` - -Multilayer format：Set key value in the array - -```json -[ - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - }, - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - } -] -``` - -eg： -Query the CPU information of the custom system. The exposed interface is `/metrics/cpu`. We need `hostname,core,useage` Metric. -If there is only one virtual machine, its single-layer format is : - -```json -{ - "hostname": "linux-1", - "core": 1, - "usage": 78.0, - "allTime": 200, - "runningTime": 100 -} -``` - -If there are multiple virtual machines, the multilayer format is: : - -```json -[ - { - "hostname": "linux-1", - "core": 1, - "usage": 78.0, - "allTime": 200, - "runningTime": 100 - }, - { - "hostname": "linux-2", - "core": 3, - "usage": 78.0, - "allTime": 566, - "runningTime": 34 - }, - { - "hostname": "linux-3", - "core": 4, - "usage": 38.0, - "allTime": 500, - "runningTime": 20 - } -] -``` - -**The corresponding monitoring template yml can be configured as follows** - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -params: - # field-field name identifier - - field: host - # name-parameter field display name - name: - zh-CN: 主机Host - en-US: Host - # type-field type, style(most mappings are input label type attribute) - type: host - # required or not true-required false-optional - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # When type is number, range is used to represent the range. - range: '[0,65535]' - required: true - # port default - defaultValue: 80 - # Prompt information of parameter input box - placeholder: 'Please enter the port' -# Metric group list -metrics: -# The first monitoring Metric group cpu -# Note：the built-in monitoring Metrics have (responseTime - response time) - - name: cpu - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. - priority: 0 - # metrics fields list - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: hostname - type: 1 - label: true - - field: usage - type: 0 - unit: '%' - - field: core - type: 0 -# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# Specific collection configuration when the protocol is HTTP protocol - http: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /metrics/cpu - # request mode: GET POST PUT DELETE PATCH - method: GET - # enable ssl/tls or not, that is to say, HTTP or HTTPS. The default is false - ssl: false - # parsing method for reponse data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring - # 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 deleted file mode 100644 index 810556ea95d..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -id: extend-http-example-hertzbeat -title: Tutorial 1 Adapting a monitoring type based on HTTP protocol -sidebar_label: Tutorial 1 Adapting an HTTP protocol monitoring ---- - -Through this tutorial, we describe step by step how to add a monitoring type based on the http protocol under the hertzbeat monitoring tool. - -Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [http Protocol Customization](extend-http). - -### HTTP protocol parses the general response structure to obtain metric data - -> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data. - -``` -{ - "code": 200, - "msg": "success", - "data": {} -} - -``` - -As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API -`http://localhost:1157/api/summary`, the response data is: - -``` -{ - "msg": null, - "code": 0, - "data": { - "apps": [ - { - "category": "service", - "app": "jvm", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - }, - { - "category": "service", - "app": "website", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - } - ] - } -} -``` - -**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** - -### Add custom monitoring template `hertzbeat` - -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -Here we define a custom monitoring type `app` named `hertzbeat` which use the HTTP protocol to collect data. - -**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# The monitoring type eg: linux windows tomcat mysql aws... -app: hertzbeat -# The monitoring i18n name -name: - zh-CN: HertzBeat监控系统 - en-US: HertzBeat Monitor -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - - field: host - # name-param field display i18n name - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - type: host - # required-true or false - required: true - # field-param field key - - field: port - # name-param field display i18n name - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - type: number - # when type is number, range is required - range: '[0,65535]' - # required-true or false - required: true - # default value - defaultValue: 1157 - - field: ssl - name: - zh-CN: 启用HTTPS - en-US: HTTPS - type: boolean - required: true - - field: timeout - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - type: number - required: false - hide: true - - field: authType - name: - zh-CN: 认证方式 - en-US: Auth Type - type: radio - required: false - hide: true - options: - - label: Basic Auth - value: Basic Auth - - label: Digest Auth - value: Digest Auth - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: false - hide: true - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - hide: true -metrics: - # the first metrics summary - # attention: Built-in monitoring metrics contains (responseTime - Response time) - - name: summary - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - priority: 0 - # collect metrics content - fields: - # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') - - field: app - type: 1 - label: true - - field: category - type: 1 - - field: status - type: 0 - - field: size - type: 0 - - field: availableSize - type: 0 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here - protocol: http - # the config content when protocol is http - http: - # http host: ipv4 ipv6 domain - host: ^_^host^_^ - # http port - port: ^_^port^_^ - # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary - url: /api/summary - timeout: ^_^timeout^_^ - # http method: GET POST PUT DELETE PATCH, default fixed value is GET - method: GET - # if enabled https, default value is false - ssl: ^_^ssl^_^ - # http auth - authorization: - # http auth type: Basic Auth, Digest Auth, Bearer Token - type: ^_^authType^_^ - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - digestAuthUsername: ^_^username^_^ - digestAuthPassword: ^_^password^_^ - # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here - parseType: jsonPath - parseScript: '$.data.apps.*' - -``` - -**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type.** - -![](/img/docs/advanced/extend-http-example-1.png) - -### The system page adds the monitoring of `hertzbeat` monitoring type - -> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring. - -![](/img/docs/advanced/extend-http-example-2.png) - -![](/img/docs/advanced/extend-http-example-3.png) - -> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details! - -![](/img/docs/advanced/extend-http-example-4.png) - -### Set threshold alarm notification - -> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add recipients, set alarm notifications, etc. Have Fun!!! - ----- - -#### over - -This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! - -If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. - -**github: ** - -**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 deleted file mode 100644 index d53e304500d..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md +++ /dev/null @@ -1,393 +0,0 @@ ---- -id: extend-http-example-token -title: Tutorial 2 Obtain TOKEN index value based on HTTP protocol for subsequent collection and authentication -sidebar_label: Tutorial 2 Get TOKEN for subsequent authentication ---- - -Through this tutorial, we will describe step by step how to modify on the basis of tutorial 1, add an metrics, first call the authentication interface to obtain the TOKEN, and use the TOKEN as a parameter for the subsequent metrics collection and authentication. - -Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [http Protocol Customization](extend-http). - -### Request process - -【**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. - -**We need `POST` to call the login interface `/api/account/auth/form` to get `accessToken`, the request body (json format) is as follows**: - -```json -{ - "credential": "hertzbeat", - "identifier": "admin" -} -``` - -**The response structure data is as follows**: - -```json -{ - "data": { - "token": "xxxx", - "refreshToken": "xxxx" - }, - "msg": null, - "code": 0 -} -``` - -### Add custom monitoring type `hertzbeat_token` - -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -1. The custom monitoring type needs to add a new configuration monitoring template yml. We directly reuse the `hertzbeat` monitoring type in Tutorial 1 and modify it based on it - -A monitoring configuration definition file named after the monitoring type - hertzbeat_token - -We directly reuse the definition content in `hertzbeat` and modify it to our current monitoring type `hertzbeat_auth` configuration parameters, such as `app, category, etc`. - -```yaml -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... -app: hertzbeat_token -name: - en-GB: HertzBeat Monitoring (Token) - en-US: Hertz Beat Monitor (Token) -params: - # field - field name identifier - - field: host - # name - parameter field display name - name: - en-CN: Host Host - en-US: Host - # type-field type, style (mostly map input tag type attribute) - type: host - # Whether it is a required item true-required false-optional - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - # When the type is number, use range to represent the range - range: '[0,65535]' - required: true - # port default - defaultValue: 1157 - # Parameter input box prompt information - placeholder: 'Please enter the port' - - field: ssl - name: - en-CN: Enable SSL - en-US: SSL - # When the type is boolean, the front end uses switch to display the switch - type: boolean - required: false - - field: contentType - name: - en-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - en-CN: request BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# Index group list configuration under todo -metrics: .... - -``` - -### Define metrics `auth` login request to get `token` - -1. Add an index group definition `auth` in `hertzbeat_token`, set the collection priority to the highest 0, and collect the index `token`. - -```yaml - -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... -app: hertzbeat_token -name: - en-GB: HertzBeat Monitoring (Token) - en-US: Hertz Beat Monitor (Token) -params: - # field - field name identifier - - field: host - # name - parameter field display name - name: - en-CN: Host Host - en-US: Host - # type-field type, style (mostly map input tag type attribute) - type: host - # Whether it is a required item true-required false-optional - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - # When the type is number, use range to represent the range - range: '[0,65535]' - required: true - # port default - defaultValue: 1157 - # Parameter input box prompt information - placeholder: 'Please enter the port' - - field: ssl - name: - en-CN: Enable SSL - en-US: SSL - # When the type is boolean, the front end uses switch to display the switch - type: boolean - required: false - - field: contentType - name: - en-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - en-CN: request BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# List of metricss -metrics: - # The first monitoring index group auth - # Note: Built-in monitoring metrics have (responseTime - response time) - - name: auth - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 0 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: token - type: 1 - - field: refreshToken - type: 1 - # Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /api/account/auth/form - # Request method GET POST PUT DELETE PATCH - method: POST - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - payload: ^_^payload^_^ - # request header content - headers: - content-type: ^_^contentType^_^ - # Response data analysis method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring - parseType: jsonPath - parseScript: '$.data' - -``` - -**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 -{ - "credential": "hertzbeat", - "identifier": "admin" -} -``` - -![](/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.** - -![](/img/docs/advanced/extend-http-example-6.png) - -![](/img/docs/advanced/extend-http-example-7.png) - -### Use `token` as a variable parameter to collect and use the following metricss - -**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:** - -```yaml - - name: summary -# When the protocol is the http protocol, the specific collection configuration - http: - # authentication - authorization: - # Authentication methods: Basic Auth, Digest Auth, Bearer Token - type: Bearer Token - bearerTokenToken: ^o^token^o^ -``` - -**The final `hertzbeat_token` template yml is defined as follows:** - -```yaml - -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... -app: hertzbeat_token -name: - en-GB: HertzBeat Monitoring (Token) - en-US: Hertz Beat Monitor (Token) -params: - # field - field name identifier - - field: host - # name - parameter field display name - name: - en-CN: Host Host - en-US: Host - # type-field type, style (mostly map input tag type attribute) - type: host - # Whether it is a required item true-required false-optional - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - # When the type is number, use range to represent the range - range: '[0,65535]' - required: true - # port default - defaultValue: 1157 - # Parameter input box prompt information - placeholder: 'Please enter the port' - - field: ssl - name: - en-CN: Enable SSL - en-US: SSL - # When the type is boolean, the front end uses switch to display the switch - type: boolean - required: false - - field: contentType - name: - en-CN: Content-Type - en-US: Content-Type - type: text - placeholder: 'Request Body Type' - required: false - - field: payload - name: - en-CN: request BODY - en-US: BODY - type: textarea - placeholder: 'Available When POST PUT' - required: false -# List of metricss -metrics: -# The first monitoring index group cpu -# Note: Built-in monitoring metrics have (responseTime - response time) - - name: auth - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 0 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: token - type: 1 - - field: refreshToken - type: 1 - # Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /api/account/auth/form - # Request method GET POST PUT DELETE PATCH - method: POST - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - payload: ^_^payload^_^ - # request header content - headers: - content-type: ^_^contentType^_^ - ^_^headers^_^: ^_^headers^_^ - # Request parameter content - params: - ^_^params^_^: ^_^params^_^ - # Response data analysis method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring - parseType: jsonPath - parseScript: '$.data' ---- - - name: summary - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 1 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: category - type: 1 - - field: app - type: 1 - - field: size - type: 0 - - field: status - type: 0 -# Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /api/summary - # Request method GET POST PUT DELETE PATCH - method: GET - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - # authentication - authorization: - # Authentication methods: Basic Auth, Digest Auth, Bearer Token - type: Bearer Token - bearerTokenToken: ^o^token^o^ - # Response data analysis method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring - parseType: jsonPath - parseScript: '$.data.apps.*' - -``` - -**After the configuration is complete, save and apply, and check the monitoring details page** - -![](/img/docs/advanced/extend-http-example-8.png) - -![](/img/docs/advanced/extend-http-example-9.png) - -### Set threshold alarm notification - -> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add a new recipient, set alarm notification, etc. Have Fun!!! - ---- - -#### over - -This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! - -If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. - -**github: ** - -**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 deleted file mode 100644 index 4e12fe86b57..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -id: extend-http-jsonpath -title: HTTP Protocol JsonPath Parsing Method -sidebar_label: JsonPath Parsing Method ---- - -> After calling the HTTP api to obtain the response data, use JsonPath script parsing method to parse the response data. - -Note⚠️ The response data is JSON format. - -**Use the JsonPath script to parse the response data into data that conforms to the data structure rules specified by HertzBeat** - -#### JsonPath Operator - -[JSONPath online verification](https://www.jsonpath.cn) - -| JSONPATH | Help description | -|------------------|----------------------------------------------------------------------------------------| -| $ | Root object or element | -| @ | Current object or element | -| . or [] | Child element operator | -| .. | Recursively match all child elements | -| * | Wildcard. Match all objects or elements | -| [] | Subscript operator, jsonpath index starts from 0 | -| [,] | Join operator, return multiple results as an array. Jsonpath allows the use of aliases | -| [start:end:step] | Array slice operator | -| ?() | Filter (script) expression | -| () | Script Expression | - -#### HertzBeat data format specification - -Single layer format ：key-value - -```json -{ - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" -} -``` - -Multilayer format：Set key value in the array - -```json -[ - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - }, - { - "metricName1": "metricValue", - "metricName2": "metricValue", - "metricName3": "metricValue", - "metricName4": "metricValue" - } -] -``` - -#### Example - -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 -{ - "firstName": "John", - "lastName" : "doe", - "age" : 26, - "address" : { - "streetAddress": "naist street", - "city" : "Nara", - "postalCode" : "630-0192" - }, - "number": [ - { - "type": "core", - "num": 3343 - }, - { - "type": "home", - "num": 4543 - } - ] -} -``` - -We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： - -```json -[ - { - "type": "core", - "num": 3343 - }, - { - "type": "home", - "num": 4543 - } -] -``` - -This data structure conforms to the data format specification of HertzBeat, and the Metric `type,num` is successfully extracted. - -**The corresponding monitoring template yml can be configured as follows** - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -params: - # field-field name identifier - - field: host - # name-parameter field display name - name: - zh-CN: 主机Host - en-US: Host - # type-field type, style(most mappings are input label type attribute) - type: host - # required or not true-required false-optional - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # When type is number, range is used to represent the range. - range: '[0,65535]' - required: true - # port default - defaultValue: 80 - # Prompt information of parameter input box - placeholder: 'Please enter the port' -# Metric group list -metrics: -# The first monitoring Metric group person -# Note：the built-in monitoring Metrics have (responseTime - response time) - - name: cpu - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. - priority: 0 - # metrics fields list - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: type - type: 1 - label: true - - field: num - type: 0 -# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# Specific collection configuration when the protocol is HTTP protocol - http: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /metrics/person - # request mode GET POST PUT DELETE PATCH - method: GET - # enable ssl/tls or not, that is to say, HTTP or HTTPS. The default is false - ssl: false - # parsing method for response data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring - # jsonPath parsing is used here - 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 deleted file mode 100644 index 58094187429..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -id: extend-http -title: HTTP Protocol Custom Monitoring -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**】 - -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) -**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. - -### Monitoring Templates YML - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg：Define a custom monitoring type `app` named `example_http` which use the HTTP protocol to collect data. - -**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example_http -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -params: - # field-field name identifier - - field: host - # name-parameter field display name - name: - zh-CN: 主机Host - en-US: Host - # type-field type, style(most mappings are input label type attribute) - type: host - # required or not true-required false-optional - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # When type is number, range is used to represent the range. - range: '[0,65535]' - required: true - # port default - defaultValue: 80 - # Prompt information of parameter input box - placeholder: 'Please enter the port' - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - # When type is text, use limit to indicate the string limit size - limit: 20 - required: false - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - - field: ssl - name: - zh-CN: 启动SSL - en-US: Enable SSL - # When type is boolean, front end uses switch to show the switch - type: boolean - required: false - - field: method - name: - zh-CN: 请求方式 - en-US: Method - type: radio - required: true - # When type is radio or checkbox, option indicates the list of selectable values {name1:value1,name2:value2} - options: - - label: GET request - value: GET - - label: POST request - value: POST - - label: PUT request - value: PUT - - label: DELETE request - value: DELETE -# Metric group list -metrics: -# The first monitoring Metric group cpu -# Note：the built-in monitoring Metrics have (responseTime - response time) - - name: cpu - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. - priority: 0 - # metrics fields list - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: hostname - type: 1 - label: true - - field: usage - type: 0 - unit: '%' - - field: cores - type: 0 - - field: waitTime - type: 0 - unit: s -# (optional)Monitoring Metric alias mapping to the Metric name above. The field used to collect interface data is not the final Metric name directly. This alias is required for mapping conversion. - aliasFields: - - hostname - - core1 - - core2 - - usage - - allTime - - runningTime -# (optional)The Metric calculation expression works with the above alias to calculate the final required Metric value. -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - hostname=hostname - - cores=core1+core2 - - usage=usage - - waitTime=allTime-runningTime -# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# Specific collection configuration when the protocol is HTTP protocol - http: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /metrics/cpu - # request mode: GET POST PUT DELETE PATCH - method: GET - # enable ssl/tls or not, that is to say, HTTP or HTTPS. The default is false - ssl: false - # request header content - headers: - apiVersion: v1 - # request parameter content - params: - param1: param1 - param2: param2 - # authorization - authorization: - # authorization method: Basic Auth, Digest Auth, Bearer Token - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - # parsing method for reponse data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring - # todo xmlPath-xmlPath script, prometheus-Prometheus data rules - parseType: jsonPath - parseScript: '$' - - - name: memory - priority: 1 - fields: - - field: hostname - type: 1 - label: true - - field: total - type: 0 - unit: kb - - field: usage - type: 0 - unit: '%' - - field: speed - type: 0 - protocol: http - http: - host: ^_^host^_^ - port: ^_^port^_^ - url: /metrics/memory - method: GET - headers: - apiVersion: v1 - params: - param1: param1 - param2: param2 - authorization: - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - parseType: default -``` diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md deleted file mode 100644 index 1f766b08da0..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -id: extend-jdbc -title: JDBC Protocol Custom Monitoring -sidebar_label: JDBC 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 JDBC(support mysql,mariadb,postgresql,sqlserver at present) to customize Metric monitoring. -> JDBC protocol custom monitoring allows us to easily monitor Metrics we want by writing SQL query statement. - -### JDBC protocol collection process - -【**System directly connected to MYSQL**】->【**Run SQL query statement**】->【**parse reponse data: oneRow, multiRow, columns**】->【**Metric data extraction**】 - -It can be seen from the process that we define a monitoring type of JDBC protocol. We need to configure SSH request parameters, configure which Metrics to obtain, and configure query SQL statements. - -### Data parsing method - -We can obtain the corresponding Metric data through the data fields queried by SQL and the Metric mapping we need. At present, there are three mapping parsing methods：oneRow, multiRow, columns. - -#### **oneRow** - -> Query a row of data, return the column name of the result set through query and map them to the queried field. - -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. - -#### **multiRow** - -> Query multiple rows of data, return the column names of the result set and map them to the queried fields. - -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. - -#### **columns** - -> 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; -SQL response data： - -| key | value | -|-------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | - -Here by mapping the Metric field with the key of the response data, we can obtain the corresponding value as collection and monitoring data. - -### 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. - -### Monitoring Templates YML - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg：Define a custom monitoring type `app` named `example_sql` which use the JDBC protocol to collect data. - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: db -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example_sql -name: - zh-CN: 模拟MYSQL应用类型 - en-US: MYSQL EXAMPLE APP -# Monitoring parameter definition file is used to define required input parameter field structure definition Front-end page render input parameter box according to structure -params: - - field: host - name: - zh-CN: 主机Host - en-US: Host - type: host - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 80 - placeholder: 'Please enter the port' - - field: database - name: - zh-CN: 数据库名称 - en-US: Database - type: text - required: false - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: false - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - - field: url - name: - zh-CN: Url - en-US: Url - type: text - required: false -# Metric group list -metrics: - - name: basic - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. - priority: 0 - # metrics fields list - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: version - type: 1 - label: true - - field: port - type: 1 - - field: datadir - type: 1 - - field: max_connections - type: 0 - # (optional)Monitoring Metric alias mapping to the Metric name above. The field used to collect interface data is not the final Metric name directly. This alias is required for mapping conversion. - aliasFields: - - version - - version_compile_os - - version_compile_machine - - port - - datadir - - max_connections - # (optional)The Metric calculation expression works with the above alias to calculate the final required Metric value. - # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - port=port - - datadir=datadir - - max_connections=max_connections - - version=version+"_"+version_compile_os+"_"+version_compile_machine - protocol: jdbc - jdbc: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - platform: mysql - username: ^_^username^_^ - password: ^_^password^_^ - database: ^_^database^_^ - # SQL query method：oneRow, multiRow, columns - queryType: columns - # sql - sql: show global variables where Variable_name like 'version%' or Variable_name = 'max_connections' or Variable_name = 'datadir' or Variable_name = 'port'; - url: ^_^url^_^ - - - name: status - priority: 1 - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: threads_created - type: 0 - - field: threads_connected - type: 0 - - field: threads_cached - type: 0 - - field: threads_running - type: 0 - # (optional)Monitoring Metric alias mapping to the Metric name above. The field used to collect interface data is not the final Metric name directly. This alias is required for mapping conversion. - aliasFields: - - threads_created - - threads_connected - - threads_cached - - threads_running - # (optional)The Metric calculation expression works with the above alias to calculate the final required Metric value. - # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - threads_created=threads_created - - threads_connected=threads_connected - - threads_cached=threads_cached - - threads_running=threads_running - protocol: jdbc - jdbc: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - platform: mysql - username: ^_^username^_^ - password: ^_^password^_^ - database: ^_^database^_^ - # SQL query method: oneRow, multiRow, columns - queryType: columns - # sql - sql: show global status where Variable_name like 'thread%' or Variable_name = 'com_commit' or Variable_name = 'com_rollback' or Variable_name = 'questions' or Variable_name = 'uptime'; - url: ^_^url^_^ - - - name: innodb - priority: 2 - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: innodb_data_reads - type: 0 - unit: times - - field: innodb_data_writes - type: 0 - unit: times - - field: innodb_data_read - type: 0 - unit: kb - - field: innodb_data_written - type: 0 - unit: kb - protocol: jdbc - jdbc: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - platform: mysql - username: ^_^username^_^ - password: ^_^password^_^ - database: ^_^database^_^ - # SQL query method：oneRow, multiRow, columns - queryType: columns - # sql - 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 deleted file mode 100644 index e354a4152fd..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -id: extend-jmx -title: JMX Protocol Custom Monitoring -sidebar_label: JMX Protocol Custom Monitoring ---- - -> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use JMX to customize Metric monitoring. -> JMX protocol custom monitoring allows us to easily monitor Metrics we want by config JMX Mbeans Object. - -### JMX protocol collection process - -【**Peer Server Enable Jmx Service**】->【**HertzBeat Connect Peer Server Jmx**】->【**Query Jmx Mbean Object Data**】->【**Metric data extraction**】 - -It can be seen from the process that we define a monitoring type of JMX protocol. We need to configure JMX request parameters, configure which Metrics to obtain, and configure Mbeans Object. - -### Data parsing method - -By configuring the monitoring template YML metrics `field`, `aliasFields`, `objectName` of the `jmx` protocol to map and parse the `Mbean` object information exposed by the peer system. - -### Custom Steps - -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -Configuration usages of the monitoring templates yml are detailed below. - -### Monitoring Templates YML - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg：Define a custom monitoring type `app` named `example_jvm` which use the JVM protocol to collect data. - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: service -# The monitoring type eg: linux windows tomcat mysql aws... -app: example_jvm -# The monitoring i18n name -name: - zh-CN: 自定义JVM虚拟机 - en-US: CUSTOM JVM -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - - field: host - # name-param field display i18n name - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - type: host - # required-true or false - required: true - # field-param field key - - field: port - # name-param field display i18n name - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - type: number - # when type is number, range is required - range: '[0,65535]' - # required-true or false - required: true - # default value - defaultValue: 9999 - # field-param field key - - field: url - # name-param field display i18n name - name: - zh-CN: JMX URL - en-US: JMX URL - # type-param field type(most mapping the html input type) - type: text - # required-true or false - required: false - # hide param-true or false - hide: true - # param field input placeholder - placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi' - # field-param field key - - field: username - # name-param field display i18n name - name: - zh-CN: 用户名 - en-US: Username - # type-param field type(most mapping the html input type) - type: text - # when type is text, use limit to limit string length - limit: 20 - # required-true or false - required: false - # hide param-true or false - hide: true - # field-param field key - - field: password - # name-param field display i18n name - name: - zh-CN: 密码 - en-US: Password - # type-param field type(most mapping the html input tag) - type: password - # required-true or false - required: false - # hide param-true or false - hide: true -# collect metrics config list -metrics: - # metrics - basic - - name: basic - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - priority: 0 - # collect metrics content - fields: - # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label - - field: VmName - type: 1 - - field: VmVendor - type: 1 - - field: VmVersion - type: 1 - - field: Uptime - type: 0 - unit: ms - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: jmx - # the config content when protocol is jmx - jmx: - # host: ipv4 ipv6 domain - host: ^_^host^_^ - # port - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - # jmx mbean object name - objectName: java.lang:type=Runtime - url: ^_^url^_^ - - - name: memory_pool - priority: 1 - fields: - - field: name - type: 1 - label: true - - field: committed - type: 0 - unit: MB - - field: init - type: 0 - unit: MB - - field: max - type: 0 - unit: MB - - field: used - type: 0 - unit: MB - units: - - committed=B->MB - - init=B->MB - - max=B->MB - - used=B->MB - # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field - aliasFields: - - Name - - Usage->committed - - Usage->init - - Usage->max - - Usage->used - # mapping and conversion expressions, use these and aliasField above to calculate metrics value - # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - name=Name - - committed=Usage->committed - - init=Usage->init - - max=Usage->max - - used=Usage->used - protocol: jmx - jmx: - # host: ipv4 ipv6 domain - host: ^_^host^_^ - # port - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - objectName: java.lang:type=MemoryPool,name=* - url: ^_^url^_^ -``` diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-point.md b/home/versioned_docs/version-v1.4.x/advanced/extend-point.md deleted file mode 100644 index 3f02f6040f4..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-point.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -id: extend-point -title: Custom Monitoring -sidebar_label: Custom Monitoring ---- - -> HertzBeat has custom monitoring ability. You only need to configure monitoring template yml to fit a custom monitoring type. -> Custom monitoring currently supports [HTTP protocol](extend-http)，[JDBC protocol](extend-jdbc), [SSH protocol](extend-ssh), [JMX protocol](extend-jmx), [SNMP protocol](extend-snmp). And it will support more general protocols in the future. - -### Custom Monitoring Steps - -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** - -------- - -Configuration usages of the monitoring templates yml are detailed below. - -### Monitoring Templates YML - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg：Define a custom monitoring type `app` named `example2` which use the HTTP protocol to collect data. - -**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# The monitoring type eg: linux windows tomcat mysql aws... -app: example2 -# The monitoring i18n name -name: - zh-CN: 模拟网站监测 - en-US: EXAMPLE WEBSITE -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - - field: host - # name-param field display i18n name - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - type: host - # required-true or false - required: true - # field-param field key - - field: port - # name-param field display i18n name - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - type: number - # when type is number, range is required - range: '[0,65535]' - # required-true or false - required: true - # default value - defaultValue: 80 - # field-param field key - - field: uri - # name-param field display i18n name - name: - zh-CN: 相对路径 - en-US: URI - # type-param field type(most mapping the html input tag) - type: text - # when type is text, use limit to limit string length - limit: 200 - # required-true or false - required: false - # param field input placeholder - placeholder: 'Website uri path(no ip port) EG:/console' - # field-param field key - - field: ssl - # name-param field display i18n name - name: - zh-CN: 启用HTTPS - en-US: HTTPS - # type-param field type(most mapping the html input type) - type: boolean - # required-true or false - required: true - # field-param field key - - field: timeout - # name-param field display i18n name - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - # type-param field type(most mapping the html input tag) - type: number - # required-true or false - required: false - # hide param-true or false - hide: true - -metrics: - # metrics - summary, inner monitoring metrics (responseTime - response time, keyword - number of keywords) - - name: summary - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - priority: 0 - # collect metrics content - fields: - # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label - - field: responseTime - type: 0 - unit: ms - - field: keyword - type: 0 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http - # the config content when protocol is http - http: - # http host: ipv4 ipv6 domain - host: ^_^host^_^ - # http port - port: ^_^port^_^ - # http url - url: ^_^uri^_^ - timeout: ^_^timeout^_^ - # http method: GET POST PUT DELETE PATCH - method: GET - # if enabled https - ssl: ^_^ssl^_^ - # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule - parseType: website - -``` diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-push.md b/home/versioned_docs/version-v1.4.x/advanced/extend-push.md deleted file mode 100644 index 18e190d7f5d..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-push.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: extend-push -title: Push Style Custom Monitoring -sidebar_label: Push Style Custom Monitoring ---- - -> Push style curstom monitor is a type of monitor which allow user to configure metrics format and push metrics to hertzbeat with their own service. -> Here we will introduce how to use this feature. - -### Push style custom monitor collection process - -【Peer Server Start Pushing Metrics】 -> 【HertzBeat Push Module Stage Metrics】-> 【HertzBeat Collect Module collect Metrics Periodically】 - -### Data parsing method - -HertzBeat will parsing metrics with the format configured by user while adding new monitor. - -### Create Monitor Steps - -HertzBeat DashBoard -> Service Monitor -> Push Style Monitor -> New Push Style Monitor -> set Push Module Host (hertzbeat server ip, usually 127.0.0.1/localhost) -> set Push Module Port (hertzbeat server port, usually 1157) -> configure metrics field (unit: string, type: 0 number / 1 string) -> end - ---- - -### Monitor Configuration Example - -![](/img/docs/advanced/extend-push-example-1.png) diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md b/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md deleted file mode 100644 index 3dae2b8b6dd..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -id: extend-snmp -title: SNMP Protocol Custom Monitoring -sidebar_label: SNMP Protocol Custom Monitoring ---- - -> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use SNMP to customize Metric monitoring. -> JMX protocol custom monitoring allows us to easily monitor Metrics we want by config SNMP MIB OIDs. - -### SNMP protocol collection process - -【**Peer Server Enable SNMP Service**】->【**HertzBeat Connect Peer Server SNMP**】->【**Query Oids Data**】->【**Metric data extraction**】 - -It can be seen from the process that we define a monitoring type of Snmp protocol. We need to configure Snmp request parameters, configure which Metrics to obtain, and configure oids. - -### Data parsing method - -By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` protocol of the monitoring template YML to capture the data specified by the peer and parse the mapping. - -### Custom Steps - -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** - -![](/img/docs/advanced/extend-point-1.png) - -------- - -Configuration usages of the monitoring templates yml are detailed below. - -### Monitoring Templates YML - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg：Define a custom monitoring type `app` named `example_windows` which use the SNMP protocol to collect data. - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring -category: os -# The monitoring type eg: linux windows tomcat mysql aws... -app: windows -# The monitoring i18n name -name: - zh-CN: Windows操作系统 - en-US: OS Windows -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - - field: host - # name-param field display i18n name - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - type: host - # required-true or false - required: true - # field-param field key - - field: port - # name-param field display i18n name - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - type: number - # when type is number, range is required - range: '[0,65535]' - # required-true or false - required: true - # default value - defaultValue: 161 - # field-param field key - - field: version - # name-param field display i18n name - name: - zh-CN: SNMP 版本 - en-US: SNMP Version - # type-param field type(radio mapping the html radio tag) - type: radio - # required-true or false - required: true - # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} - options: - - label: SNMPv1 - value: 0 - - label: SNMPv2c - value: 1 - # field-param field key - - field: community - # name-param field display i18n name - name: - zh-CN: SNMP 团体字 - en-US: SNMP Community - # type-param field type(most mapping the html input type) - type: text - # when type is text, use limit to limit string length - limit: 100 - # required-true or false - required: true - # param field input placeholder - placeholder: 'Snmp community for v1 v2c' - # field-param field key - - field: timeout - # name-param field display i18n name - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - # type-param field type(most mapping the html input type) - type: number - # when type is number, range is required - range: '[0,100000]' - # required-true or false - required: false - # hide-is hide this field and put it in advanced layout - hide: true - # default value - defaultValue: 6000 -# collect metrics config list -metrics: - # metrics - system - - name: system - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - priority: 0 - # collect metrics content - fields: - # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label - - field: name - type: 1 - - field: descr - type: 1 - - field: uptime - type: 1 - - field: numUsers - type: 0 - - field: services - type: 0 - - field: processes - type: 0 - - field: responseTime - type: 0 - unit: ms - - field: location - type: 1 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: snmp - # the config content when protocol is snmp - snmp: - # server host: ipv4 ipv6 domain - host: ^_^host^_^ - # server port - port: ^_^port^_^ - # snmp connect timeout - timeout: ^_^timeout^_^ - # snmp community - community: ^_^community^_^ - # snmp version - version: ^_^version^_^ - # snmp operation: get, walk - operation: get - # metrics oids: metric_name - oid_value - oids: - name: 1.3.6.1.2.1.1.5.0 - descr: 1.3.6.1.2.1.1.1.0 - uptime: 1.3.6.1.2.1.25.1.1.0 - numUsers: 1.3.6.1.2.1.25.1.5.0 - services: 1.3.6.1.2.1.1.7.0 - processes: 1.3.6.1.2.1.25.1.6.0 - location: 1.3.6.1.2.1.1.6.0 -``` diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md deleted file mode 100644 index 2226a2a6334..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -id: extend-ssh -title: SSH Protocol Custom Monitoring -sidebar_label: SSH 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 SSH protocol to customize Metric monitoring. -> SSH protocol custom monitoring allows us to easily monitor and collect the Linux Metrics we want by writing sh command script. - -### SSH protocol collection process - -【**System directly connected to Linux**】->【**Run shell command script statement**】->【**parse response data: oneRow, multiRow**】->【**Metric data extraction**】 - -It can be seen from the process that we define a monitoring type of SSH protocol. We need to configure SSH request parameters, configure which Metrics to obtain, and configure query script statements. - -### Data parsing method - -We can obtain the corresponding Metric data through the data fields queried by the SHELL script and the Metric mapping we need. At present, there are two mapping parsing methods：oneRow and multiRow which can meet the needs of most Metrics. - -#### **oneRow** - -> 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}'` -The data responded by the terminal is： - -``` -tombook -14:00:15 up 72 days -``` - -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 - -#### **multiRow** - -> 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 -Memory metrics original query command：`free -m`, Console response： - -```shell - total used free shared buff/cache available -Mem: 7962 4065 333 1 3562 3593 -Swap: 8191 33 8158 -``` - -In hertzbeat multiRow format parsing requires a one-to-one mapping between the column name of the response data and the indicaotr value, so the corresponding query SHELL script is: -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` -Console response is： - -```shell -total used free buff_cache available -7962 4066 331 3564 3592 -``` - -Here the Metric field and the response data can be mapped into collected data one by one. - -### 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. - -### Monitoring Templates YML - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg：Define a custom monitoring type `app` named `example_linux` which use the SSH protocol to collect data. - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: os -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example_linux -name: - zh-CN: 模拟LINUX应用类型 - en-US: LINUX EXAMPLE APP -params: - - field: host - name: - zh-CN: 主机Host - en-US: Host - type: host - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 22 - placeholder: 'Please enter the port' - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: true - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: true -# Metric group list -metrics: - # The first monitoring Metric group basic - # Note：: the built-in monitoring Metrics have (responseTime - response time) - - name: basic - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. - priority: 0 - # metrics fields list - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: hostname - type: 1 - label: true - - field: version - type: 1 - - field: uptime - type: 1 - # protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: ssh - # Specific collection configuration when the protocol is SSH protocol - ssh: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - script: (uname -r ; hostname ; uptime | awk -F "," '{print $1}' | sed "s/ //g") | sed ":a;N;s/\n/^/g;ta" | awk -F '^' 'BEGIN{print "version hostname uptime"} {print $1, $2, $3}' - # parsing method for reponse data：oneRow, multiRow - parseType: multiRow - - - name: cpu - priority: 1 - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: info - type: 1 - - field: cores - type: 0 - unit: the number of cores - - field: interrupt - type: 0 - unit: number - - field: load - type: 1 - - field: context_switch - type: 0 - unit: number - # protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: ssh - # Specific collection configuration when the protocol is SSH protocol - ssh: - # 主机host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - script: "LANG=C lscpu | awk -F: '/Model name/ {print $2}';awk '/processor/{core++} END{print core}' /proc/cpuinfo;uptime | sed 's/,/ /g' | awk '{for(i=NF-2;i<=NF;i++)print $i }' | xargs;vmstat 1 1 | awk 'NR==3{print $11}';vmstat 1 1 | awk 'NR==3{print $12}'" - parseType: oneRow - - - name: memory - priority: 2 - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: total - type: 0 - unit: Mb - - field: used - type: 0 - unit: Mb - - field: free - type: 0 - unit: Mb - - field: buff_cache - type: 0 - unit: Mb - - field: available - type: 0 - unit: Mb - # protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: ssh - # Specific collection configuration when the protocol is SSH protocol - ssh: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - username: ^_^username^_^ - password: ^_^password^_^ - 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 deleted file mode 100644 index cd594f5a378..00000000000 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: extend-tutorial -title: Quick Tutorial Customize and adapt a monitoring based on HTTP protocol -sidebar_label: Tutorial Case ---- - -Through this tutorial, we describe step by step how to customize and adapt a monitoring type based on the http protocol under the hertzbeat monitoring tool. - -Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [Http Protocol Customization](extend-http). - -### HTTP protocol parses the general response structure to obtain metrics data - -> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data. - -``` -{ - "code": 200, - "msg": "success", - "data": {} -} - -``` - -As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API -`http://localhost:1157/api/summary`, the response data is: - -``` -{ - "msg": null, - "code": 0, - "data": { - "apps": [ - { - "category": "service", - "app": "jvm", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - }, - { - "category": "service", - "app": "website", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - } - ] - } -} -``` - -**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** - -### Add Monitoring Template Yml - -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** - -> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> -> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -Here we define a custom monitoring type `app` named `hertzbeat` which use the HTTP protocol to collect data. - -**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** - -```yaml -# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# The monitoring type eg: linux windows tomcat mysql aws... -app: hertzbeat -# The monitoring i18n name -name: - zh-CN: HertzBeat监控系统 - en-US: HertzBeat Monitor -# Input params define for monitoring(render web ui by the definition) -params: - # field-param field key - - field: host - # name-param field display i18n name - name: - zh-CN: 主机Host - en-US: Host - # type-param field type(most mapping the html input type) - type: host - # required-true or false - required: true - # field-param field key - - field: port - # name-param field display i18n name - name: - zh-CN: 端口 - en-US: Port - # type-param field type(most mapping the html input type) - type: number - # when type is number, range is required - range: '[0,65535]' - # required-true or false - required: true - # default value - defaultValue: 1157 - - field: ssl - name: - zh-CN: 启用HTTPS - en-US: HTTPS - type: boolean - required: true - - field: timeout - name: - zh-CN: 超时时间(ms) - en-US: Timeout(ms) - type: number - required: false - hide: true - - field: authType - name: - zh-CN: 认证方式 - en-US: Auth Type - type: radio - required: false - hide: true - options: - - label: Basic Auth - value: Basic Auth - - label: Digest Auth - value: Digest Auth - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - limit: 20 - required: false - hide: true - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - hide: true -metrics: - # the first metrics summary - # attention: Built-in monitoring metrics contains (responseTime - Response time) - - name: summary - # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel - # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue - priority: 0 - # collect metrics content - fields: - # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') - - field: app - type: 1 - label: true - - field: category - type: 1 - - field: status - type: 0 - - field: size - type: 0 - - field: availableSize - type: 0 - # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here - protocol: http - # the config content when protocol is http - http: - # http host: ipv4 ipv6 domain - host: ^_^host^_^ - # http port - port: ^_^port^_^ - # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary - url: /api/summary - timeout: ^_^timeout^_^ - # http method: GET POST PUT DELETE PATCH, default fixed value is GET - method: GET - # if enabled https, default value is false - ssl: ^_^ssl^_^ - # http auth - authorization: - # http auth type: Basic Auth, Digest Auth, Bearer Token - type: ^_^authType^_^ - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - digestAuthUsername: ^_^username^_^ - digestAuthPassword: ^_^password^_^ - # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here - parseType: jsonPath - parseScript: '$.data.apps.*' -``` - -**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type.** - -![](/img/docs/advanced/extend-http-example-1.png) - -### The system page adds the monitoring of `hertzbeat` monitoring type - -> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring. - -![](/img/docs/advanced/extend-http-example-2.png) - -![](/img/docs/advanced/extend-http-example-3.png) - -> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details! - -![](/img/docs/advanced/extend-http-example-4.png) - -### Set threshold alarm notification - -> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add a new recipient, set alarm notification, etc. Have Fun!!! - ----- - -#### over - -This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! - -If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill! - -**github: ** - -**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 deleted file mode 100644 index ef3cc911969..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/activemq.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -id: activemq -title: Monitoring Apache ActiveMQ -sidebar_label: Apache ActiveMQ -keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] ---- - -> Monitoring the running status of Apache ActiveMQ message middleware, nodes, topics and other related metrics. - -**Use Protocol: JMX** - -### Pre-monitoring Operations - -> You need to enable the `JMX` service on ActiveMQ, HertzBeat uses the JMX protocol to collect metrics from ActiveMQ. - -1. Modify the `conf/activemq.xml` file in the installation directory to enable JMX - -> Add `userJmx="true"` attribute in `broker` tag - -```xml - - - -``` - -2. Modify the `bin/env` file in the installation directory, configure the JMX port IP, etc. - -The original configuration information will be as follows - -```text -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.port=11099" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=${ACTIVEMQ_CONF}/jmx.password" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=${ACTIVEMQ_CONF}/jmx.access" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false" - -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" -``` - -Update to the following configuration, ⚠️ pay attention to modify `local external IP` - -```text -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=${ACTIVEMQ_CONF}/jmx.password" -# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=${ACTIVEMQ_CONF}/jmx.access" - -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.port=11099" -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false" -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.authenticate=false" -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Djava.rmi.server.hostname=本机对外IP" - -ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" -``` - -3. Restart the ACTIVEMQ service, and add the corresponding ActiveMQ monitoring in HertzBeat. The parameters use the IP port configured by JMX. - -### Configuration parameters - -| Parameter name | Parameter help description | -|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). | -| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. | -| JMX port | The HTTP port provided by JMX, the default is 11099. | -| JMX URL | Optional, customize the JMX URL connection | -| Username | Username used for authentication | -| password | password used for authentication | -| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful | -| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here | - -### Collect Metrics - -#### metrics: broker - -| Metric Name | Unit | Description | -|-------------------------|------|-----------------------------------------------------------------------| -| BrokerName | None | The name of the broker. | -| BrokerVersion | None | The version of the broker. | -| Uptime | None | Uptime of the broker. | -| UptimeMillis | ms | Uptime of the broker in milliseconds. | -| Persistent | None | Messages are synchronized to disk. | -| MemoryPercentUsage | % | Percent of memory limit used. | -| StorePercentUsage | % | Percent of store limit used. | -| TempPercentUsage | % | Percent of temp limit used. | -| CurrentConnectionsCount | None | Attribute exposed for management | -| TotalConnectionsCount | None | Attribute exposed for management | -| TotalEnqueueCount | None | Number of messages that have been sent to the broker. | -| TotalDequeueCount | None | Number of messages that have been acknowledged on the broker. | -| TotalConsumerCount | None | Number of message consumers subscribed to destinations on the broker. | -| TotalProducerCount | None | Number of message producers active on destinations on the broker. | -| TotalMessageCount | None | Number of unacknowledged messages on the broker. | -| AverageMessageSize | None | Average message size on this broker | -| MaxMessageSize | None | Max message size on this broker | -| MinMessageSize | None | Min message size on this broker | - -#### metrics: topic - -| Metric Name | Unit | Description | -|--------------------|------|-------------------------------------------------------------------------------------------| -| Name | None | Name of this destination. | -| MemoryLimit | MB | Memory limit, in bytes, used by undelivered messages before paging to temporary storage. | -| MemoryPercentUsage | None | The percentage of the memory limit used | -| ProducerCount | None | Number of producers attached to this destination | -| ConsumerCount | None | Number of consumers subscribed to this destination. | -| EnqueueCount | None | Number of messages that have been sent to the destination. | -| DequeueCount | None | Number of messages that has been acknowledged (and removed) from the destination. | -| ForwardCount | None | Number of messages that have been forwarded (to a networked broker) from the destination. | -| InFlightCount | None | Number of messages that have been dispatched to, but not acknowledged by, consumers. | -| DispatchCount | None | Number of messages that has been delivered to consumers, including those not acknowledged | -| ExpiredCount | None | Number of messages that have been expired. | -| StoreMessageSize | B | The memory size of all messages in this destination's store. | -| AverageEnqueueTime | ms | Average time a message was held on this destination. | -| MaxEnqueueTime | ms | The longest time a message was held on this destination | -| MinEnqueueTime | ms | The shortest time a message was held on this destination | -| TotalBlockedTime | ms | Total time (ms) messages have been blocked by flow control | -| AverageMessageSize | B | Average message size on this destination | -| MaxMessageSize | B | Max message size on this destination | -| MinMessageSize | B | Min message size on this destination | - -#### metrics: memory_pool - -| Metric Name | Unit | Description | -|-------------|------|--------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### metrics: class_loading - -| Metric Name | Unit | Description | -|-----------------------|------|--------------------------| -| LoadedClassCount | | Loaded Class Count | -| TotalLoadedClassCount | | Total Loaded Class Count | -| UnloadedClassCount | | Unloaded Class Count | - -#### metrics: thread - -| Metric Name | Unit | Description | -|-------------------------|------|----------------------------| -| TotalStartedThreadCount | | Total Started Thread Count | -| ThreadCount | | Thread Count | -| PeakThreadCount | | Peak Thread Count | -| DaemonThreadCount | | Daemon Thread Count | -| CurrentThreadUserTime | ms | Current Thread User Time | -| CurrentThreadCpuTime | ms | Current Thread Cpu Time | diff --git a/home/versioned_docs/version-v1.4.x/help/airflow.md b/home/versioned_docs/version-v1.4.x/help/airflow.md deleted file mode 100644 index a7f77f7f5b6..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/airflow.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: airflow -title: 监控：Apache Airflow监控 -sidebar_label: Apache Airflow -keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ---- - -> 对Apache Airflow通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|-----------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：airflow_health - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------|------|------------------| -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | - -#### 指标集合：airflow_version - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------|------|---------------| -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | diff --git a/home/versioned_docs/version-v1.4.x/help/alert_console.md b/home/versioned_docs/version-v1.4.x/help/alert_console.md deleted file mode 100644 index 45ab7d791d3..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_console.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: alert_console -title: Custom console address in alarm template -sidebar_label: Console address in alarm template ---- - -> After the threshold is triggered, send the alarm information. When you notify through DingDing / enterprise Wechat / FeiShu robot or email, the alarm content has a detailed link to log in to the console. - -### Custom settings - -In our startup configuration file application.yml, find the following configuration - -```yml -alerter: - console-url: #Here is our custom console address -``` - -The default value is the official console address of HertzBeat. 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 deleted file mode 100644 index 36e332d9b21..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: alert_dingtalk -title: Alert DingDing robot notification -sidebar_label: Alert DingDing robot notification -keywords: [open source monitoring tool, open source alerter, open source DingDing robot notification] ---- - -> After the threshold is triggered send alarm information and notify the recipient by DingDing robot. - -### Operation steps - -1. **【DingDing desktop client】-> 【Group settings】-> 【Intelligent group assistant】-> 【Add new robot-select custom】-> 【Set robot name and avatar】-> 【Note⚠️Set custom keywords: HertzBeat】 ->【Copy its webhook address after adding successfully】** - -> Note⚠️ When adding a robot, its custom keywords need to be set in the security setting block: HertzBeat. Other security settings or the IP segment don't need to be filled in. - -![email](/img/docs/help/alert-notice-8.png) - -2. **【Save access_token value of the WebHook address of the robot】** - -> 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】** - -![email](/img/docs/help/alert-notice-9.png) - -4. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-notice-4.png) - -### DingDing robot common issues - -1. DingDing group did not receive the robot alarm notification. - -> Please check whether there is any triggered alarm information in the alarm center. -> Please check whether DingDing robot is configured with security custom keywords ：HertzBeat. -> Please check whether the robot ACCESS_TOKEN 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_discord.md b/home/versioned_docs/version-v1.4.x/help/alert_discord.md deleted file mode 100644 index 68296148f22..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_discord.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: alert_discord -title: Alert Discord Bot Notifications -sidebar_label: Alert Discord bot notification -keywords: [open source monitoring tool, open source alerter, open source Discord bot notification] ---- - -> Send an alarm message after the threshold is triggered, and notify the recipient through the Discord robot. - -## Steps - -### Create an application in Discord, create a robot under the application, and get the robot Token - -1. Visit [https://discord.com/developers/applications](https://discord.com/developers/applications) to create an application - -![bot](/img/docs/help/discord-bot-1.png) - -2. Create a robot under the application and get the robot Token - -![bot](/img/docs/help/discord-bot-2.png) - -![bot](/img/docs/help/discord-bot-3.png) - -3. Authorize the bot to the chat server - -> Authorize the robot under the OAuth2 menu, select `bot` for `SCOPES`, `BOT PERMISSIONS` select `Send Messages` - -![bot](/img/docs/help/discord-bot-4.png) - -> Obtain the URL generated at the bottom, and the browser accesses this URL to officially authorize the robot, that is, to set which chat server the robot will join. - -4. Check if your chat server has joined robot members - -![bot](/img/docs/help/discord-bot-5.png) - -### Enable developer mode and get Channel ID - -1. Personal Settings -> Advanced Settings -> Enable Developer Mode - -![bot](/img/docs/help/discord-bot-6.png) - -2. Get channel Channel ID - -> Right-click the chat channel you want to send the robot message to, click the COPY ID button to get the Channel ID - -![bot](/img/docs/help/discord-bot-7.png) - -### Add an alarm notification person in HertzBeat, the notification method is Discord Bot - -1. **[Alarm notification] -> [Add recipient] -> [Select Discord robot notification method] -> [Set robot Token and ChannelId] -> [OK]** - -![email](/img/docs/help/discord-bot-8.png) - -4. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]** - -> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**. - -![email](/img/docs/help/alert-notice-policy.png) - -### Discord Bot Notification FAQ - -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 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 deleted file mode 100644 index c507a970bae..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_email.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: alert_email -title: Alert email notification -sidebar_label: Alert email notification -keywords: [open source monitoring tool, open source alerter, open source email notification] ---- - -> After the threshold is triggered send alarm information and notify the recipient by email. - -### Operation steps - -1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** - -![email](/img/docs/help/alert-notice-1.png) - -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) - -3. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-notice-4.png) - -### Email notification common issues - -1. Hertzbeat deployed on its own intranet cannot receive email notifications - -> Hertzbeat needs to configure its own mail server, not tancloud. Please confirm whether you have configured its own mail server in application.yml - -2. Cloud environment tancloud cannot receive email notification - -> 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. - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_enterprise_wechat_app.md b/home/versioned_docs/version-v1.4.x/help/alert_enterprise_wechat_app.md deleted file mode 100644 index 1d5d41a15bc..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_enterprise_wechat_app.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: alert_enterprise_wechat_app -title: Alert Enterprise Wechat App notification -sidebar_label: Alert Enterprise Wechat App notification -keywords: [open source monitoring tool, open source alerter, open source Enterprise Wechat App notification] ---- - -> After the threshold is triggered send alarm information and notify the recipient by enterprise WeChat App. - -### Operation steps - -1. **【Enterprise Wechat backstage】-> 【App Management】-> 【Create an app】-> 【Set App message】->【Copy AgentId and Secret adding successfully】** - -![email](/img/docs/help/alert-wechat-1.jpg) - -2. **【Alarm notification】->【Add new recipient】 ->【Select Enterprise WeChat App notification method】->【Set Enterprise WeChat ID,Enterprise App ID and Enterprise App Secret 】-> 【Confirm】** - -![email](/img/docs/help/alert-wechat-2.jpg) - -3. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-wechat-3.jpg) - -### Enterprise WeChat App common issues - -1. Enterprise WeChat App did not receive the alarm notification. - -> Please check if the user has application permissions. -> Please check if the enterprise application callback address settings are normal. -> Please check if the server IP is on the enterprise application whitelist. - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_feishu.md b/home/versioned_docs/version-v1.4.x/help/alert_feishu.md deleted file mode 100644 index 38f7c72cf03..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_feishu.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: alert_feishu -title: Alert FeiShu robot notification -sidebar_label: Alert FeiShu robot notification -keywords: [open source monitoring tool, open source alerter, open source feishu bot notification] ---- - -> After the threshold is triggered send alarm information and notify the recipient by FeiShu robot. - -### Operation steps - -1. **【FeiShu client】-> 【Group settings】-> 【Group robot】-> 【Add new robot】-> 【Set robot name and avatar】-> 【Copy its webhook address after adding successfully】** - -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` -> 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】** - -4. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-notice-4.png) - -### FeiShu robot notification common issues - -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 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 deleted file mode 100644 index 26bde4ed2e5..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_slack.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: alert_slack -title: Alert Slack Webhook Notifications -sidebar_label: Alert Slack Webhook Notification -keywords: [open source monitoring tool, open source alerter, open source slack webhook notification] ---- - -> Send an alarm message after the threshold is triggered, and notify the recipient through the Slack Webhook. - -## Steps - -### Open Webhook in Slack, get Webhook URL - -Refer to the official website document [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) - -### Add an alarm notifier to HertzBeat, and the notification method is Slack Webhook - -1. **【Alarm Notification】->【Add Recipient】->【Select Slack Webhook Notification Method】->【Set Webhook URL】-> 【OK】** - -![email](/img/docs/help/slack-bot-1.png) - -2. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]** - -> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**. - -![email](/img/docs/help/alert-notice-policy.png) - -### Slack Notification FAQ - -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 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 deleted file mode 100644 index 53774315561..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_smn.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: alert_smn -title: Alert Huawei Cloud SMN Notifications -sidebar_label: Alert Huawei Cloud SMN Notifications -keywords: [ open source monitoring tool, open source alerter, open source Huawei Cloud SMN notification ] ---- - -> Send an alarm message after the threshold is triggered, and notify the recipient through the Huawei Cloud SMN. - -### 操作步骤 - -1. **According to [Huawei Cloud SMN Official Document](https://support.huaweicloud.com/qs-smn/smn_json.html) activate the SMN service and configure SMN** - -![alert-notice-10](/img/docs/help/alert-notice-10.png) - -2. **Save topic URN for SMN** - -![alert-notice-11](/img/docs/help/alert-notice-11.png) - -3. **According to [Huawei Cloud Signature Document](https://support.huaweicloud.com/devg-apisign/api-sign-provide.html) obtain AK, SK, and project ID** - -![alert-notice-12](/img/docs/help/alert-notice-12.png) - -![alert-notice-13](/img/docs/help/alert-notice-13.png) - -4. **【Alarm Notification】->【Add Recipient】->【Select Slack Webhook Notification Method】->【Set Huawei Cloud SMN AK, SK and other configurations】-> 【OK】** - -![alert-notice-14](/img/docs/help/alert-notice-14.png) - -5. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]** - -> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**. - -![email](/img/docs/help/alert-notice-4.png) - -### Huawei Cloud SMN Notification FAQ - -1. Huawei Cloud SMN did not receive the robot warning notification - -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the Huawei Cloud SMN AK, SK and other configurations are configured correctly, and whether the alarm policy association has been configured - -Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_telegram.md b/home/versioned_docs/version-v1.4.x/help/alert_telegram.md deleted file mode 100644 index 1689788f0f4..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_telegram.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: alert_telegram -title: Alert Telegram Bot Notification -sidebar_label: Alert Telegram bot notification -keywords: [open source monitoring tool, open source alerter, open source Telegram bot notification] ---- - -> Send an alarm message after the threshold is triggered, and notify the recipient through the Telegram robot. - -## Steps - -### Create a bot in Telegram, get Bot Token and UserId - -1. Use [@BotFather](https://t.me/BotFather) to create your own bot and get an access token `Token` - -![telegram-bot](/img/docs/help/telegram-bot-1.png) - -2. Get the `User ID` of the recipient - -**Use the recipient account you want to notify to send a message to the newly created Bot account**, -Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token from the previous step to replace the `**, and respond to the first in the `Json` data A `result.message.from.id` value is the recipient's `User ID` - -```json -{ - "ok": true, - "result": [ - { - "update_id": 632299191, - "message": { - "from":{ - "id": "User ID" - }, - "chat":{ - }, - "date": 1673858065, - "text": "111" - } - } - ] -} -``` - -3. Record and save the `Token` and `User Id` we got - -### Add an alarm notification person to HertzBeat, the notification method is Telegram Bot - -1. **【Alarm Notification】->【Add Recipient】->【Select Telegram Robot Notification Method】->【Set Robot Token and UserId】-> 【OK】** - -![email](/img/docs/help/telegram-bot-2.png) - -4. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]** - -> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**. - -![email](/img/docs/help/alert-notice-policy.png) - -### Telegram Bot Notification FAQ - -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 -> 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 deleted file mode 100644 index f4b934fd27c..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_threshold.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: alert_threshold -title: Threshold alarm configuration -sidebar_label: Threshold alarm configuration ---- - -> Configure the alarm threshold (warning alarm, critical alarm, emergency alarm) for the monitoring Metrics, and the system calculates and triggers the alarm according to the threshold configuration and the collected Metric data. - -### Operation steps - -1. **【Alarm configuration】->【Add new threshold】-> 【Confirm after configuration】** - -![threshold](/img/docs/help/alert-threshold-1.png) - -As shown above： - -**Metric object**：Select the monitoring Metric object for which we need to configure the threshold. Eg：website monitoring type -> summary Metric set -> responseTime-response time Metric -**Threshold trigger expression**：Calculate and judge whether to trigger the threshold according to this expression. See the page prompts for expression environment variables and operators. Eg：set the response time greater than 50 to trigger an alarm, and the expression is `responseTime > 50`. For detailed help on threshold expression, see [Threshold expression help](alert_threshold_expr) -**Alarm level**：The alarm level that triggers the threshold, from low to high: warning, critical, emergency. -**Trigger times**：How many times will the threshold be triggered before the alarm is really triggered. -**Notification template**：Notification information Template sent after alarm triggering, See page prompts for template environment variables, eg：`${app}.${metrics}.${metric} Metric's value is ${responseTime}, greater than 50 triggers an alarm` -**Global default**： Set whether this threshold is valid for such global Metrics, and the default is No. After adding a new threshold, you need to associate the threshold with the monitoring object, so that the threshold will take effect for this monitoring. -**Enable alarm**：This alarm threshold configuration is enabled or disabled. - -2. **Threshold association monitoring⚠️ 【Alarm configuration】-> 【Threshold just set】-> 【Configure associated monitoring】-> 【Confirm after configuration】** - -> **Note⚠️ After adding a new threshold, you need to associate the threshold with the monitoring object(That is, to set this threshold for which monitoring is effective), so that the threshold will take effect for this monitoring.**。 - -![threshold](/img/docs/help/alert-threshold-2.png) - -![threshold](/img/docs/help/alert-threshold-3.png) - -**After the threshold alarm is configured, the alarm information that has been successfully triggered can be seen in 【alarm center】.** -**If you need to notify the relevant personnel of the alarm information by email, Wechat, DingDing and Feishu, it can be configured in 【alarm notification】.** - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md b/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md deleted file mode 100644 index 45d80f82764..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: alert_threshold_expr -title: Threshold trigger expression -sidebar_label: Threshold trigger expression ---- - -> When we configure the threshold alarm, we need to configure the threshold trigger expression. The system calculates whether to trigger the alarm according to the expression and the monitoring index value. Here is a detailed introduction to the use of the expression. - -#### Operators supported by expressions - -``` -equals(str1,str2) -== -< -<= -> ->= -!= -( ) -+ -- -&& -|| -``` - -Rich operators allow us to define expressions freely. -Note⚠️ For the equality of string, please use `equals(str1,str2)`, while for the equality judgment of number, please use == or != - -#### Supported environment variables - -> Environment variables, i.e. supported variables such as Metric values, are used in the expression. When the threshold value is calculated and judged, the variables will be replaced with actual values for calculation. - -Non fixed environment variables：These variables will change dynamically according to the monitoring Metric object we choose. For example, if we choose **response time Metric of website monitoring**, the environment variables will have `responseTime - This is the response time variable` -If we want to set **when the response time of website monitoring is greater than 400** to trigger an alarm，the expression is `responseTime>400` - -Fixed environment variables(Rarely used)：`instance : Row instance value` -This variable is mainly used to calculate multiple instances. For example, we collected `usage`(`usage is non fixed environment variables`) of disk C and disk D, but we only want to set the alarm when **the usage of C disk is greater than 80**. Then the expression is `equals(instance,"c")&&usage>80` - -#### Expression setting case - -1. Website monitoring -> Trigger alarm when the response time is greater than or equal to 400ms - `responseTime>=400` -2. API monitoring -> Trigger alarm when the response time is greater than 3000ms - `responseTime>3000` -3. Entire site monitoring -> Trigger alarm when URL(instance) path is `https://baidu.com/book/3` and the response time is greater than 200ms - `equals(instance,"https://baidu.com/book/3")&&responseTime>200` -4. MYSQL monitoring -> status Metric group -> Trigger alarm when hreads_running(number of running threads) Metric is greater than 7 - `threads_running>7` - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_webhook.md b/home/versioned_docs/version-v1.4.x/help/alert_webhook.md deleted file mode 100644 index d1741d71481..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_webhook.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: alert_webhook -title: Alert WebHook callback notification -sidebar_label: Alert webHook notification -keywords: [open source monitoring tool, open source alerter, open source webhook notification] ---- - -> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient. - -### Operation steps - -1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】** - -![email](/img/docs/help/alert-notice-5.png) - -2. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-notice-4.png) - -### WebHook callback POST body BODY content - -Content format：JSON - -```json -{ - "alarmId": 76456, - "target": "${target}", - "thresholdId": 33455, - "priority": 0, - "content": "udp_port monitoring availability alert, code is FAIL", - "status": 0, - "times": 1, - "triggerTime": "2022-02-25T13:32:13", - "tags": { - "app": "windows", - "monitorId": "180427708350720", - "metrics": "availability", - "code": "UN_CONNECTABLE", - "thresholdId": "112", - "monitorName": "WINDOWS_192.168.124.12" - } -} -``` - -| | | -|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| alarmId | integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID | -| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field | -| thresholdId | integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID | -| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 | -| content | string title: The actual content of the alarm notification 告警通知实际内容 | -| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 | -| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 | -| triggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) | -| tags | example: {key1:value1} | - -### Webhook notification common issues - -1. WebHook callback did not take effect - -> Please check whether there is any triggered alarm information in the alarm center. -> Please check whether the configured webhook callback address is correct. - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_wework.md b/home/versioned_docs/version-v1.4.x/help/alert_wework.md deleted file mode 100644 index ce344200301..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/alert_wework.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: alert_wework -title: Alert enterprise Wechat notification -sidebar_label: Alert enterprise Wechat notification -keywords: [open source monitoring tool, open source alerter, open source WeWork notification] ---- - -> After the threshold is triggered send alarm information and notify the recipient by enterprise Wechat robot. - -### Operation steps - -1. **【Enterprise Wechat】-> 【Group settings】-> 【Group robot】-> 【Add new robot】-> 【Set robot name and avatar】-> 【Copy its webhook address after adding successfully】** - -![email](/img/docs/help/alert-notice-6.jpg) - -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` -> 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】** - -![email](/img/docs/help/alert-notice-7.png) - -4. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-notice-4.png) - -### Enterprise Wechat robot common issues - -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 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 deleted file mode 100644 index 958fb532639..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/api.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: api -title: Monitoring HTTP API -sidebar_label: HTTP API -keywords: [open source monitoring tool, monitoring http api] ---- - -> Call HTTP API interface, check whether the interface is available, and monitor its response time and other Metrics. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 | -| Relative path | Suffix path of website address except IP port. For example, the relative path of `www.tancloud.io/console` website is `/console` | -| Request mode | Set the request mode of interface call：GET, POST, PUT, DELETE | -| Enable HTTPS | Whether to access the website through HTTPS. Note⚠️When HTTPS is enabled, the default corresponding port needs to be changed to 443 | -| Username | User name used for interface Basic authentication or Digest authentication | -| Password | Password used for interface Basic authentication or Digest authentication | -| Content-Type | Set the resource type when carrying the BODY request body data request | -| Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：summary - -| 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 deleted file mode 100644 index 858a1d2bb94..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/centos.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: centos -title: CentOS operating system monitoring -sidebar_label: CentOS operating system -keywords: [open source monitoring tool, open source os monitoring tool, monitoring CentOS operating system metrics] ---- - -> Collect and monitor the general performance Metrics of CentOS operating system. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Linux SSH. The default is 22 | -| Username | SSH connection user name, optional | -| Password | SSH connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|--------------------------| -| hostname | none | Host name | -| version | none | Operating system version | -| uptime | none | System running time | - -#### Metric set：cpu - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|------------------------------------------------| -| info | none | CPU model | -| cores | cores | Number of CPU cores | -| interrupt | number | Number of CPU interrupts | -| load | none | Average load of CPU in the last 1/5/15 minutes | -| context_switch | number | Number of current context switches | -| usage | % | CPU usage | - -#### Metric set：memory - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------------------| -| total | Mb | Total memory capacity | -| used | Mb | User program memory | -| free | Mb | Free memory capacity | -| buff_cache | Mb | Memory occupied by cache | -| available | Mb | Remaining available memory capacity | -| usage | % | Memory usage | - -#### Metric set：disk - -| Metric name | Metric unit | Metric help description | -|---------------|-------------|----------------------------------------| -| disk_num | blocks | Total number of disks | -| partition_num | partitions | Total number of partitions | -| block_write | blocks | Total number of blocks written to disk | -| block_read | blocks | Number of blocks read from disk | -| write_rate | iops | Rate of writing disk blocks per second | - -#### Metric set：interface - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|------------------------------| -| interface_name | none | Network card name | -| receive_bytes | byte | Inbound data traffic(bytes) | -| transmit_bytes | byte | Outbound data traffic(bytes) | - -#### Metric set：disk_free - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| filesystem | none | File system name | -| used | Mb | Used disk size | -| 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 deleted file mode 100644 index f8e031bfe20..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/dm.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: dm -title: Monitoring DM database -sidebar_label: DM Database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring DM database metrics] ---- - -> Collect and monitor the general performance metrics of the DM database. DM8+ is supported. - -### Configuration parameters - -| Parameter name | Parameter help description | -|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitor Host | Monitored peer IPV4, IPV6 or domain name. Note ⚠️ without protocol headers (eg: https://, http://). | -| Monitor Name | Identifies the name of this monitor. The name needs to be unique. | -| Port | The port provided by the database externally, the default is 5236. | -| Query Timeout | Set the timeout when the SQL query does not respond to data, in ms milliseconds, the default is 3000 milliseconds. | -| database name | database instance name, optional. | -| username | database connection username, optional | -| password | database connection password, optional | -| URL | Database connection URL, optional | -| Collection Interval | Monitor periodical collection data interval, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and then continue to add and modify operations if the detection is successful | -| Description Remarks | More remarks that identify and describe this monitoring, users can remark information here | - -### Collect metrics - -#### Metric collection: basic - -| Metric Name | Metric Unit | Metric Help Description | -|--------------|-------------|-------------------------------| -| PORT_NUM | None | Database exposed service port | -| CTL_PATH | None | Control File Path | -| MAX_SESSIONS | None | Maximum database connections | - -#### Metric collection: status - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|----------------------------------| -| status$ | None | Open/Close status of DM database | - -#### Metric collection: thread - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------------------------------------------------------| -| 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 deleted file mode 100644 index 63fe3b03a19..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/docker.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -id: docker -title: Monitor：Docker Monitor -sidebar_label: Docker Monitor -keywords: [open source monitoring tool, open source docker monitoring tool, monitoring docker metrics] ---- - -> Collect and monitor general performance Metrics of Docker containers. - -## Pre-monitoring operations - -If you want to monitor the container information in `Docker`, you need to open the port according to the following steps, so that the collection request can obtain the corresponding information. - -**1. Edit the docker.server file:** - -````shell -vi /usr/lib/systemd/system/docker.service -```` - -Find the **[Service]** node, modify the ExecStart property, and add `-H tcp://0.0.0.0:2375` - -````shell -ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock -H tcp://0.0.0.0:2375 -```` - -This is equivalent to the **2375** port that is open to the outside world. Of course, it can be modified to other ports according to your own situation. - -**2. Reload the Docker configuration to take effect:** - -```shell -systemctl daemon-reload -systemctl restart docker -``` - -**Note: Remember to open the `2375` port number in the server console.** - -**3. If the above method does not work:** - -Open the `2375` port number inside the server. - -```shell -firewall-cmd --zone=public --add-port=2375/tcp --permanent -firewall-cmd --reload -``` - -### Configuration parameters - -| Parameter name | Parameter help description | -|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitor Host | Monitored peer IPV4, IPV6 or domain name. Note ⚠️ without protocol headers (eg: https://, http://). | -| Monitor Name | Identifies the name of this monitor. The name needs to be unique. | -| Port | The port provided by the database externally, the default is 2375. | -| Query Timeout | Set the timeout when getting the Docker server API interface, in ms, the default is 3000 ms. | -| Container Name | Generally monitors all running container information. | -| username | connection username, optional | -| password | connection password, optional | -| URL | Database connection URL, optional, if configured, the parameters such as database name, username and password in the URL will override the parameters configured above | -| Collection Interval | Monitor periodical collection data interval, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and then continue to add and modify operations if the detection is successful | -| Description Remarks | More remarks that identify and describe this monitoring, users can remark information here | - -### Collect metrics - -#### Metric collection: system - -| Metric Name | Metric Unit | Metric Help Description | -|--------------------|-------------|----------------------------------------------------| -| Name | None | Server Name | -| version | none | docker version number | -| os | none | server version eg: linux x86_64 | -| root_dir | none | docker folder directory eg: /var/lib/docker | -| containers | None | Total number of containers (running + not running) | -| containers_running | None | Number of running containers | -| containers_paused | none | number of containers in pause | -| images | None | The total number of container images. | -| ncpu | none | ncpu | -| mem_total | MB | Total size of memory used | -| system_time | none | system time | - -#### Metric collection: containers - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|----------------------------------------------| -| id | None | The ID of the container in Docker | -| name | None | The container name in the Docker container | -| image | None | Image used by the Docker container | -| command | None | Default startup command in Docker | -| state | None | The running state of the container in Docker | -| status | None | Update time in Docker container | - -#### Metrics collection: stats - -| Metric Name | Metric Unit | Metric Help Description | -|------------------|-------------|------------------------------------------------------------| -| name | None | The name in the Docker container | -| available_memory | MB | The amount of memory that the Docker container can utilize | -| used_memory | MB | The amount of memory already used by the Docker container | -| memory_usage | None | Memory usage of the Docker container | -| 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 deleted file mode 100644 index 3e6fd37de03..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/doris_be.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -id: doris_be -title: 监控：DORIS数据库BE监控 -sidebar_label: DORIS数据库BE -keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] ---- - -> 对DORIS数据库FE的通用性能指标进行采集监控。支持DORIS2.0.0。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|-----------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8040 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| 数据库名称 | 数据库实例名称，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：doris_be_load_channel_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------------| -| value | 无 | 当前打开的 load channel 个数 | - -#### 指标集合：doris_be_memtable_flush_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------| -| value | 无 | memtable写入磁盘的个数累计值 | - -#### 指标集合：doris_be_plan_fragment_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------------------| -| value | 无 | 当前已接收的 fragment instance 的数量 | - -#### 指标集合：doris_be_process_thread_num - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------------------| -| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | - -#### 指标集合：doris_be_query_scan_rows - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------------------------------------------------------------------| -| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | - -#### 指标集合：doris_be_result_buffer_block_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------| -| value | 无 | 当前查询结果缓存中的 query 个数 | - -#### 指标集合：doris_be_send_batch_thread_pool_queue_size - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------| -| value | 无 | 导入时用于发送数据包的线程池的排队个数 | - -#### 指标集合：doris_be_tablet_base_max_compaction_score - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------------------| -| value | 无 | 当前最大的 Base Compaction Score | - -#### 指标集合：doris_be_timeout_canceled_fragment_count - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|----------------------------------| -| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | - -#### 指标集合：doris_be_load_rows - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------------| -| value | 无 | 通过 tablet sink 发送的行数累计 | - -#### 指标集合：doris_be_all_rowsets_num - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------| -| value | 无 | 当前所有 rowset 的个数 | - -#### 指标集合：doris_be_all_segments_num - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------| -| value | 无 | 当前所有 segment 的个数 | - -#### 指标集合：doris_be_heavy_work_max_threads - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-------------------| -| value | 无 | brpc heavy线程池线程个数 | - -#### 指标集合：doris_be_light_work_max_threads - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-------------------| -| value | 无 | brpc light线程池线程个数 | - -#### 指标集合：doris_be_heavy_work_pool_queue_size - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------------------| -| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | - -#### 指标集合：doris_be_light_work_pool_queue_size - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------------------| -| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | - -#### 指标集合：doris_be_heavy_work_active_threads - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------| -| value | 无 | brpc heavy线程池活跃线程数 | - -#### 指标集合：doris_be_light_work_active_threads - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------| -| value | 无 | brpc light线程池活跃线程数 | - -#### 指标集合：doris_be_compaction_bytes_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------|------|------------------------------| -| base | 字节 | Base Compaction 的数据量累计 | -| cumulative | 字节 | Cumulative Compaction 的数据量累计 | - -#### 指标集合：doris_be_disks_avail_capacity - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------------------------------| -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | - -#### 指标集合：doris_be_disks_total_capacity - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------------------------------| -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | - -#### 指标集合：doris_be_local_bytes_read_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|----------------------------| -| value | 字节 | 由 `LocalFileReader` 读取的字节数 | - -#### 指标集合：doris_be_local_bytes_written_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|----------------------------| -| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | - -#### 指标集合：doris_be_memory_allocated_bytes - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------------------------------| -| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | diff --git a/home/versioned_docs/version-v1.4.x/help/doris_fe.md b/home/versioned_docs/version-v1.4.x/help/doris_fe.md deleted file mode 100644 index 23432ad2cbd..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/doris_fe.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: doris_fe -title: 监控：DORIS数据库FE监控 -sidebar_label: DORIS数据库FE -keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] ---- - -> 对DORIS数据库FE的通用性能指标进行采集监控。支持DORIS2.0.0。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|-----------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8030 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| 数据库名称 | 数据库实例名称，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：doris_fe_connection_total - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|-----------------| -| value | 无 | 当前FE的MySQL端口连接数 | - -#### 指标集合：doris_fe_edit_log_clean - -不应失败，如失败，需人工介入 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|----------------| -| success | 无 | 清理历史元数据日志成功的次数 | -| failed | 无 | 清理历史元数据日志失败的次数 | - -#### 指标集合：doris_fe_edit_log - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|------|--------------| -| write | 无 | 元数据日志写入次数的计数 | -| read | 无 | 元数据日志读取次数的计数 | -| current | 无 | 元数据日志当前数量 | -| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | -| current_bytes | 字节 | 元数据日志当前值 | - -#### 指标集合：doris_fe_image_clean - -不应失败，如失败，需人工介入 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|------------------| -| success | 无 | 清理历史元数据镜像文件成功的次数 | -| failed | 无 | 清理历史元数据镜像文件失败的次数 | - -#### 指标集合：doris_fe_image_write - -不应失败，如失败，需人工介入 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|----------------| -| success | 无 | 生成元数据镜像文件成功的次数 | -| failed | 无 | 生成元数据镜像文件失败的次数 | - -#### 指标集合：doris_fe_query_err - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|----------| -| value | 无 | 错误查询的累积值 | - -#### 指标集合：doris_fe_max_journal_id - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------------------------------------------------------------------------------------------------| -| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | - -#### 指标集合：doris_fe_max_tablet_compaction_score - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------------------------------------------------------------------------| -| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | - -#### 指标集合：doris_fe_qps - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------------------| -| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | - -#### 指标集合：doris_fe_query_err_rate - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|---------| -| value | 无 | 每秒错误查询数 | - -#### 指标集合：doris_fe_report_queue_size - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------------------------------------------------------| -| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | - -#### 指标集合：doris_fe_rps - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------------| -| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | - -#### 指标集合：doris_fe_scheduled_tablet_num - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------------------------------------------------------------------------------------| -| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | - -#### 指标集合：doris_fe_txn_status - -可以观测各个状态下导入事务的数量，来判断是否有堆积 - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------|------|---------| -| unknown | 无 | 未知 | -| prepare | 无 | 准备中 | -| committed | 无 | 已提交 | -| visible | 无 | 可见 | -| aborted | 无 | 已中止/已撤销 | diff --git a/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md b/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md deleted file mode 100644 index 332767b2a39..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -id: dynamic_tp -title: Monitoring DynamicTp ThreadPool -sidebar_label: DynamicTp Monitor -keywords: [open source monitoring tool, open source dynamicTp monitoring tool, monitoring DynamicTp metrics] ---- - -> Collect and monitor the thread pool performance Metrics exposed by DynamicTp actuator. - -### PreRequisites - -1. Integration Using `DynamicTp` - -`DynamicTp` is a lightweight dynamic thread pool based on the configuration center of the Jvm language. It has built-in monitoring and alarm functions, which can be realized through SPI custom extensions. - -For integrated use, please refer to the document [Quick Start](https://dynamictp.cn/guide/use/quick-start.html) - -2. Open SpringBoot Actuator Endpoint to expose `DynamicTp` Metric interface - -```yaml -management: - endpoints: - web: - exposure: - include: '*' -``` - -Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has response json data as follows: - -```json -[ - { - "poolName": "commonExecutor", - "corePoolSize": 1, - "maximumPoolSize": 1, - "queueType": "LinkedBlockingQueue", - "queueCapacity": 2147483647, - "queueSize": 0, - "fair": false, - "queueRemainingCapacity": 2147483647, - "activeCount": 0, - "taskCount": 0, - "completedTaskCount": 0, - "largestPoolSize": 0, - "poolSize": 0, - "waitTaskCount": 0, - "rejectCount": 0, - "rejectHandlerName": null, - "dynamic": false, - "runTimeoutCount": 0, - "queueTimeoutCount": 0 - }, - { - "maxMemory": "4GB", - "totalMemory": "444MB", - "freeMemory": "250.34 MB", - "usableMemory": "3.81GB" - } -] -``` - -3. Add DynamicTp monitoring under HertzBeat middleware monitoring - -### Configuration parameters - -| Parameter name | Parameter help description | -| ------------ |------------------------------------ ------------------| -| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). | -| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. | -| Port | The port provided by the application service, the default is 8080. | -| Enable HTTPS | Whether to access the website through HTTPS, note ⚠️Enable HTTPS, the default corresponding port needs to be changed to 443 | -| Base Path | Exposed interface path prefix, default /actuator | -| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful | -| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here | - -### Collect metrics - -#### Metric collection: thread_pool - -| Metric Name | Metric Unit | Metric Help Description | -|--------------------------|-------------|---------------------------------------------| -| pool_name | None | Thread pool name | -| core_pool_size | None | Number of core threads | -| maximum_pool_size | None | Maximum number of threads | -| queue_type | None | Task queue type | -| queue_capacity | MB | task queue capacity | -| queue_size | None | The current occupied size of the task queue | -| fair | None | Queue mode, SynchronousQueue will be used | -| queue_remaining_capacity | MB | task queue remaining size | -| active_count | None | Number of active threads | -| task_count | None | Total number of tasks | -| completed_task_count | None | Number of completed tasks | -| largest_pool_size | None | The largest number of threads in history | -| pool_size | none | current number of threads | -| wait_task_count | None | Number of tasks waiting to be executed | -| reject_count | None | Number of rejected tasks | -| reject_handler_name | None | Reject policy type | -| 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 deleted file mode 100644 index bad94c4b751..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/fullsite.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: fullsite -title: Monitoring Full site -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. -> Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 | -| SiteMap | Relative path of website SiteMap address, eg：/sitemap.xml | -| Enable HTTPS | Whether to access the website through HTTPS. Note⚠️When HTTPS is enabled, the default corresponding port needs to be changed to 443 | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：summary - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|------------------------------------------------------| -| url | none | URL path of web page | -| 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 deleted file mode 100644 index 9d2e9dcbf6b..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/guide.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -id: guide -title: Help Center -sidebar_label: Help Center ---- - -> Hertzbeat - An open source, real-time monitoring tool with custom-monitor and agentLess. -> Help documents and auxiliary information during use - -## 🔬 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. -> Planned monitoring type：application service, database, operating system, cloud native, open source middleware. - -### Application service monitoring - - 👉 [Website monitoring](website)
- 👉 [HTTP API](api)
- 👉 [PING Connectivity](ping)
- 👉 [Port availability](port)
- 👉 [Full site monitoring](fullsite)
- 👉 [SSL Cert monitoring](ssl_cert)
- 👉 [JVM monitoring](jvm)
- 👉 [SpringBoot2.0](springboot2)
- -### Database monitoring - - 👉 [MYSQL database monitoring](mysql)
- 👉 [MariaDB database monitoring](mariadb)
- 👉 [PostgreSQL database monitoring](postgresql)
- 👉 [SqlServer database monitoring](sqlserver)
- 👉 [Oracle database monitoring](oracle)
- 👉 [DM database monitoring](dm)
- 👉 [OpenGauss database monitoring](opengauss)
- 👉 [IoTDB database monitoring](iotdb)
- -### Operating system monitoring - - 👉 [Linux operating system monitoring](linux)
- 👉 [Windows operating system monitoring](windows)
- 👉 [Ubuntu operating system monitoring](ubuntu)
- 👉 [Centos operating system monitoring](centos)
- -### Middleware monitoring - - 👉 [Zookeeper](zookeeper)
- 👉 [Kafka](kafka)
- 👉 [Tomcat](tomcat)
- 👉 [ShenYu](shenyu)
- 👉 [DynamicTp](dynamic_tp)
- 👉 [RabbitMQ](rabbitmq)
- 👉 [ActiveMQ](activemq)
- 👉 [Jetty](jetty)
- -### CloudNative monitoring - - 👉 [Docker](docker)
- 👉 [Kubernetes](kubernetes)
- -*** - -## 💡 Alarm service - -> More liberal threshold alarm configuration (calculation expression), supports email, SMS, WebHook, DingDing, WeChat and FeiShu for alarm notification. -> The positioning of alarm service is to trigger the threshold accurately and timely, and the alarm notification can be reached in time. - -### Alarm center - -> The triggered alarm information center provides query and filtering of alarm deletion, alarm processing, mark unprocessed, alarm level status, etc. - -### Alarm configuration - -> The Metric threshold configuration provides the Metric threshold configuration in the form of expression, which can set the alarm level, trigger times, alarm notification template and whether it is enabled, correlation monitoring and other functions. - -More details see 👉 [threshold alarm](alert_threshold)
-   👉 [Threshold expression](alert_threshold_expr) - -### 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 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)
- 👉 [Configure Discord Notification](alert_webhook)
- 👉 [Configure Slack Notification](alert_webhook)
- 👉 [Configure Telegram Notification](alert_webhook)
- 👉 [Configure WebHook Notification](alert_webhook)
- 👉 [Configure enterprise WeChat Robot Notification](alert_wework)
- 👉 [Configure DingDing Robot Notification](alert_dingtalk)
- 👉 [Configure FeiShu Robot Notification](alert_feishu)
diff --git a/home/versioned_docs/version-v1.4.x/help/hadoop.md b/home/versioned_docs/version-v1.4.x/help/hadoop.md deleted file mode 100644 index e12a44807ea..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/hadoop.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: hadoop -title: Monitoring Hadoop -sidebar_label: Hadoop -keywords: [Open Source Monitoring System, Open Source Java Monitoring, Hadoop JVM Monitoring] ---- - -> Collect and monitor general performance metrics for the JVM virtual machine in Hadoop. - -**Protocol used: JMX** - -### Pre-monitoring steps - -> You need to enable JMX service in the Hadoop application before monitoring. HertzBeat uses the JMX protocol to collect performance metrics from Hadoop's JVM. - -### Steps to enable JMX protocol in the Hadoop application - -Add JVM parameters when the application starts. ⚠️Note that you can customize the exposed port and external IP. - -- 1.Enter the hadoop-env.sh configuration file and enter the following command in the terminal: - -```shell -vi $HADOOP_HOME/etc/hadoop/hadoop-env.sh -``` - -- 2.Add the following parameters, where `port` is the number of the custom-exposed port - -```shell -export HADOOP_OPTS= "$HADOOP_OPTS --Djava.rmi.server.hostname=对外ip地址 --Dcom.sun.management.jmxremote.port=9999 --Dcom.sun.management.jmxremote.ssl=false --Dcom.sun.management.jmxremote.authenticate=false " -``` - -- 3.Save and exit, and then execute "start-all.sh" in the "$HADOOP_HOME/sbin" directory to restart the service. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by JMX | -| Username | JMX connection user name, optional | -| Password | JMX connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：memory_pool - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：code_cache (Only Support JDK8) - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：class_loading - -| Metric name | Metric unit | Metric help description | -|-----------------------|-------------|--------------------------| -| LoadedClassCount | | Loaded Class Count | -| TotalLoadedClassCount | | Total Loaded Class Count | -| UnloadedClassCount | | Unloaded Class Count | - -#### Metrics Set：thread - -| Metric name | Metric unit | Metric help description | -|-------------------------|-------------|----------------------------| -| TotalStartedThreadCount | | Total Started Thread Count | -| ThreadCount | | Thread Count | -| PeakThreadCount | | Peak Thread Count | -| DaemonThreadCount | | Daemon Thread Count | -| CurrentThreadUserTime | ms | Current Thread User Time | -| CurrentThreadCpuTime | ms | Current Thread Cpu Time | diff --git a/home/versioned_docs/version-v1.4.x/help/hive.md b/home/versioned_docs/version-v1.4.x/help/hive.md deleted file mode 100644 index 1293fbd3802..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/hive.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: hive -Title: Monitoring Apache Hive -sidebar_label: Apache Hive -keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache hive metrics] ---- - -> Collect and monitor the general performance metrics exposed by the SpringBoot actuator. - -## Pre-monitoring operations - -If you want to monitor information in `Apache Hive` with this monitoring type, you need to open your `Hive Server2` in remoting mode. - -**1、Enable metastore:** - -```shell -hive --service metastore & -``` - -**2. Enable hive server2:** - -```shell -hive --service hiveserver2 & -``` - -### Configure parameters - -| Parameter name | Parameter Help describes the | -|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | -| Monitoring Name | A name that identifies this monitoring that needs to be unique. | -| Port | The default port provided by the database is 10002. | -| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 | -| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | -| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful | -| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | - -### Collect metrics - -#### metric Collection: basic - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|-----------------------------------------------------------| -| vm_name | None | The name of the virtual machine (VM) running HiveServer2. | -| vm_vendor | None | The vendor or provider of the virtual machine. | -| vm_version | None | The version of the virtual machine. | -| up_time | None | The duration for which HiveServer2 has been running. | - -#### metric Collection: enviroment - -| Metric Name | metric unit | Metrics help describe | -|----------------------|-------------|-------------------------------------------------------------------| -| https_proxyPort | None | The port number used for HTTPS proxy communication. | -| os_name | None | The name of the operating system on which HiveServer2 is running. | -| os_version | None | The version of the operating system. | -| os_arch | None | The architecture of the operating system. | -| java_runtime_name | None | The name of the Java runtime environment used by HiveServer2. | -| java_runtime_version | None | The version of the Java runtime environment. | - -#### metric Collection: thread - -| Metric Name | metric unit | Metrics help describe | -|----------------------|-------------|----------------------------------------------------------------------| -| thread_count | None | The current number of threads being used by HiveServer2. | -| total_started_thread | None | The total count of threads started by HiveServer2 since its launch. | -| peak_thread_count | None | The highest number of threads used by HiveServer2 at any given time. | -| daemon_thread_count | None | The number of daemon threads currently active in HiveServer2. | - -#### metric Collection: code_cache - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|-------------------------------------------------------------------------| -| committed | MB | The amount of memory currently allocated for the memory pool. | -| init | MB | The initial amount of memory requested for the memory pool. | -| max | MB | The maximum amount of memory that can be allocated for the memory pool. | -| used | MB | The amount of memory currently being used by the memory pool. | diff --git a/home/versioned_docs/version-v1.4.x/help/iotdb.md b/home/versioned_docs/version-v1.4.x/help/iotdb.md deleted file mode 100644 index 011b9cbec12..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/iotdb.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -id: iotdb -title: Monitoring Apache IoTDB Database -sidebar_label: IoTDB Database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring IotDB database metrics] ---- - -> Monitor the running status of the Apache IoTDB Internet of Things time series database (JVM-related), memory task clusters and other related Metrics. - -## Operation before monitoring - -You need to enable the `metrics` function in IoTDB, which will provide interface data in the form of prometheus metrics. - -To enable the `metrics` function, refer to [Official Documentation](https://iotdb.apache.org/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) - -The main steps are as follows: - -1. The metric collection is disabled by default, you need to modify the parameters in `conf/iotdb-metric.yml` first, then restart the server - -``` -# Whether to start the monitoring module, the default is false -enableMetric: true - -# Whether to enable operation delay statistics -enablePerformanceStat: false - -# Data provision method, externally provide metrics data through jmx and prometheus protocol, optional parameters: [JMX, PROMETHEUS, IOTDB], IOTDB is closed by default. -metricReporterList: - - JMX - - PROMETHEUS - -# The metric architecture used at the bottom layer, optional parameters: [MICROMETER, DROPWIZARD] -monitorType: MICROMETER - -# Initialize the level of the metric, optional parameters: [CORE, IMPORTANT, NORMAL, ALL] -metricLevel: IMPORTANT - -# Predefined metrics set, optional parameters: [JVM, LOGBACK, FILE, PROCESS, SYSTEM] -predefinedMetrics: - - JVM - - FILE -``` - -2. Restart IoTDB, open a browser or use curl to access http://servier_ip:9091/metrics, and you can see the metric data. - -3. Add the corresponding IoTDB monitoring in HertzBeat. - -### Configuration parameters - -| Parameter name | Parameter help description | -|--------|----------------------------------------- --------------| -| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). | -| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. | -| Port | The port provided by the IoTDB Metric interface, which is 9091 by default. | -| Timeout | HTTP request query timeout | -| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful | -| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here | - -### Collect metrics - -#### Metric collection: cluster_node_status - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|---------------------------------| -| name | None | Node name IP | -| status | None | Node status, 1=online 2=offline | - -#### Metric collection: jvm_memory_committed_bytes - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|------------------------------------------------| -| area | none | heap memory or nonheap memory | -| id | none | memory block | -| value | MB | The memory size currently requested by the JVM | - -#### Metric collection: jvm_memory_used_bytes - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------------| -| area | none | heap memory or nonheap memory | -| id | none | memory block | -| value | MB | JVM used memory size | - -#### Metric collection: jvm_threads_states_threads - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|---------------------------------------------------------| -| state | none | thread state | -| count | None | The number of threads corresponding to the thread state | - -#### Index collection: quantity business data - -| Metric Name | Metric Unit | Metric Help Description | -|--|------|----------------| -| name | None | Business name timeSeries/storageGroup/device/deviceUsingTemplate | -| type | none | type total/normal/template/template | -| value | None | The current timeSeries/storageGroup/device/The number of devices that have activated the template | - -#### Metric collection: cache_hit cache - -| Metric Name | Metric Unit | Metric Help Description | -| ----------- |------|------------------------------ ----------------------| -| name | None | Cache name chunk/timeSeriesMeta/bloomFilter | -| value | % | chunk/timeSeriesMeta cache hit rate, bloomFilter interception rate | - -#### Metric collection: queue task queue - -| Metric Name | Metric Unit | Metric Help Description | -| ----------- |------|------------------------------ ---------------------| -| name | None | Queue name compaction_inner/compaction_cross/flush | -| status | none | status running/waiting | -| value | None | Number of tasks at current time | - -#### Metric collection: thrift_connections - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|----------------------------------| -| 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 deleted file mode 100644 index 384387b45d6..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/issue.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: issue -title: Common issues -sidebar_label: Common issues ---- - -### Monitoring common issues - -1. **Page feedback：monitor.host: Monitoring Host must be ipv4, ipv6 or domain name** - -> As shown in the information, the entered monitoring Host must be ipv4, ipv6 or domain name, and cannot carry a protocol header, such as http - -2. **The website API and other monitoring feedback statusCode:403 or 401, but the opposite end service itself does not need authentication, and the direct access of the browser is OK** - -> Please check whether it is blocked by the firewall. For example, BaoTa/aaPanel have set the blocking of `User-Agent=Apache-HttpClient` in the request header by default. If it is blocked, please delete this blocking rule. (user-agent has been simulated as a browser in the v1.0.beat5 version. This problem does not exist) - -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 - -4. If the history chart on the monitoring page is not displayed，popup [please configure dependency service on TDengine time series database] - -> As shown in the popup window，the premise of history chart display is that you need install and configure hertzbeat's dependency service - TDengine database. -> Installation and initialization this database refers to [TDengine Installation and Initialization](../start/tdengine-init). - -### Docker Deployment common issues - -1. **MYSQL, TDENGINE and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** - The problems lies in Docker container failed to visit and connect localhost port. Beacuse the docker default network mode is Bridge mode which can't access loacl machine through localhost. - -> 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 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 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. -> 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 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`. -> 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. -> 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 deleted file mode 100644 index ccec65b5559..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/jetty.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: jetty -title: Monitoring Jetty Web Server -sidebar_label: Jetty Web Server -keywords: [open source monitoring tool, open source jetty web server monitoring tool, monitoring jetty metrics] ---- - -> Collect and monitor general performance metrics of Jetty application server - -**Usage protocol: JMX** - -### Pre-monitoring Operations - -> You need to enable the `JMX` service in the JVM application. HertzBeat uses the JMX protocol to collect metrics for the JVM. - -#### Jetty application server opens JMX protocol steps - -[Refer to official documentation](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) - -1. Start the JMX JMX-REMOTE module in Jetty - -```shell -java -jar $JETTY_HOME/start.jar --add-module=jmx -java -jar $JETTY_HOME/start.jar --add-module=jmx-remote -``` - -Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` configuration file - -2. Edit the `${JETTY_BASE}/start.d/jmx-remote.ini` configuration file to modify the JMX IP port and other parameters. - -**`localhost` needs to be modified to expose the IP** - -```text -## The host/address to bind the RMI server to. -# jetty.jmxremote.rmiserverhost=localhost - -## The port the RMI server listens to (0 means a random port is chosen). -# jetty.jmxremote.rmiserverport=1099 - -## The host/address to bind the RMI registry to. -# jetty.jmxremote.rmiregistryhost=localhost - -## The port the RMI registry listens to. -# jetty.jmxremote.rmiregistryport=1099 - -## The host name exported in the RMI stub. --Djava.rmi.server.hostname=localhost -``` - -3. Restart Jetty Server. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by JMX | -| Username | JMX connection user name, optional | -| Password | JMX connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：memory_pool - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：class_loading - -| Metric name | Metric unit | Metric help description | -|-----------------------|-------------|--------------------------| -| LoadedClassCount | | Loaded Class Count | -| TotalLoadedClassCount | | Total Loaded Class Count | -| UnloadedClassCount | | Unloaded Class Count | - -#### Metrics Set：thread - -| Metric name | Metric unit | Metric help description | -|-------------------------|-------------|----------------------------| -| TotalStartedThreadCount | | Total Started Thread Count | -| ThreadCount | | Thread Count | -| PeakThreadCount | | Peak Thread Count | -| DaemonThreadCount | | Daemon Thread Count | -| CurrentThreadUserTime | ms | Current Thread User Time | -| CurrentThreadCpuTime | ms | Current Thread Cpu Time | diff --git a/home/versioned_docs/version-v1.4.x/help/jvm.md b/home/versioned_docs/version-v1.4.x/help/jvm.md deleted file mode 100644 index 477d9fbece1..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/jvm.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: jvm -title: Monitoring JVM -sidebar_label: JVM Monitor -keywords: [open source monitoring tool, open source java jvm monitoring tool, monitoring jvm metrics] ---- - -> Collect and monitor the general performance Metrics of JVM. - -**Protocol Use：JMX** - -### JVM App Enable JMX Protocol - -1. Add JVM `VM options` When Start Server ⚠️ customIP - -Refer: - -```shell --Djava.rmi.server.hostname=customIP --Dcom.sun.management.jmxremote.port=9999 --Dcom.sun.management.jmxremote.ssl=false --Dcom.sun.management.jmxremote.authenticate=false -``` - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by JMX | -| Username | JMX connection user name, optional | -| Password | JMX connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：memory_pool - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：code_cache (Only Support JDK8) - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：class_loading - -| Metric name | Metric unit | Metric help description | -|-----------------------|-------------|--------------------------| -| LoadedClassCount | | Loaded Class Count | -| TotalLoadedClassCount | | Total Loaded Class Count | -| UnloadedClassCount | | Unloaded Class Count | - -#### Metrics Set：thread - -| Metric name | Metric unit | Metric help description | -|-------------------------|-------------|----------------------------| -| TotalStartedThreadCount | | Total Started Thread Count | -| ThreadCount | | Thread Count | -| PeakThreadCount | | Peak Thread Count | -| DaemonThreadCount | | Daemon Thread Count | -| CurrentThreadUserTime | ms | Current Thread User Time | -| CurrentThreadCpuTime | ms | Current Thread Cpu Time | diff --git a/home/versioned_docs/version-v1.4.x/help/kafka.md b/home/versioned_docs/version-v1.4.x/help/kafka.md deleted file mode 100644 index 48d06b2037b..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/kafka.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: kafka -title: Monitor：Apache Kafka -sidebar_label: Apache Kafka -keywords: [open source monitoring tool, open source apache kafka monitoring tool, monitoring apache kafka metrics] ---- - -> Collect and monitor the general performance Metrics of Apache Kafka. - -**Protocol Use：JMX** - -### Kafka Enable JMX Protocol - -1. Install Kafka - -2. Modify `kafka-server-start.sh` - -Append content in kafka-server-start.sh, Attention Replace Port And IP. - -```shell -export JMX_PORT=9999; -export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management.jmxremote.rmi.port=9999 -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false"; - -# Already Has -exec $base_dir/kafka-run-class.sh $EXTRA_ARGS kafka.Kafka "$@" -``` - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by JMX | -| Username | JMX connection user name, optional | -| Password | JMX connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：server_info - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| Version | | Kafka Version | -| StartTimeMs | ms | Start Time | -| CommitId | | Version Commit ID | - -#### Metrics Set：memory_pool - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：active_controller_count - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|--------------------------------| -| Value | | server active controller count | - -#### Metrics Set：broker_partition_count - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| Value | | broker partition count | - -#### Metrics Set：broker_leader_count - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| Value | | broker leader count | - -#### Metrics Set：broker_handler_avg_percent - -| Metric name | Metric unit | Metric help description | -|-------------------|-------------|-------------------------| -| EventType | | event type | -| RateUnit | | rate unit | -| Count | | percent count | -| OneMinuteRate | % | One Minute Rate | -| 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 deleted file mode 100644 index 3cb2336e768..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/kubernetes.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: kubernetes -Title: Monitoring Kubernetes -sidebar_label: Kubernetes Monitor -keywords: [open source monitoring tool, open source kubernetes monitoring tool, monitoring kubernetes metrics] ---- - -> Collect and monitor the general performance metrics of Kubernetes. - -## Pre-monitoring operations - -If you want to monitor the information in 'Kubernetes', you need to obtain an authorization token that can access the API Server, so that the collection request can obtain the corresponding information. - -Refer to the steps to obtain token - -#### method one - -1. Create a service account and bind the default cluster-admin administrator cluster role - -```kubectl create serviceaccount dashboard-admin -n kube-system``` - -2. User Authorization - -```shell -kubectl create clusterrolebinding dashboard-admin --clusterrole=cluster-admin --serviceaccount=kube-system:dashboard-admin -kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' -kubectl describe secret {secret} -n kube-system -``` - -#### method two - -```shell -kubectl create serviceaccount cluster-admin -kubectl create clusterrolebinding cluster-admin-manual --clusterrole=cluster-admin --serviceaccount=default:cluster-admin -kubectl create token --duration=1000h cluster-admin -``` - -### Configure parameters - -| Parameter name | Parameter Help describes the | -|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | -| Monitoring Name | A name that identifies this monitoring that needs to be unique. | -| APiServer port | K8s APiServer port, default 6443 | -| token | Authorize the Access Token | -| URL | The database connection URL is optional, if configured, the database name, user name and password parameters in the URL will override the parameter | configured above | -| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | -| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful | -| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | - -### Collect metrics - -#### metric collection: nodes - -| Metric Name | metric unit | Metrics help describe | -|--------------------|-------------|-----------------------|-----------| -| node_name | None | Node name | -| is_ready | None | Node Status | -| capacity_cpu | None | CPU capacity | -| allocatable_cpu | None | CPU | allotted | -| capacity_memory | None | Memory capacity | -| allocatable_memory | None | Memory | allocated | -| creation_time | None | Node creation time | - -#### metric Collection: namespaces - -| Metric Name | metric unit | Metrics help describe | -|---------------|-------------|-----------------------| -| namespace | None | namespace name | -| status | None | Status | -| creation_time | None | Created | - -#### metric collection: pods - -| Metric Name | metric unit | Metrics help describe | -|---------------|-------------|-------------------------------|--------------------------| -| pod | None | Pod name | -| namespace | None | The namespace | to which the pod belongs | -| status | None | Pod status | -| restart | None | Number of restarts | -| host_ip | None | The IP address of the host is | -| pod_ip | None | pod ip | -| creation_time | None | Pod creation time | -| start_time | None | Pod startup time | - -#### metric Collection: services - -| Metric Name | metric unit | Metrics help describe | -|---------------|-------------|-----------------------------------------------------------|------------------------------| -| service | None | Service Name | -| namespace | None | The namespace | to which the service belongs | -| type | None | Service Type ClusterIP NodePort LoadBalancer ExternalName | -| 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 deleted file mode 100644 index f5c77a72ca6..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/linux.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: linux -title: Monitoring：Linux operating system monitoring -sidebar_label: Linux operating system -keywords: [open source monitoring tool, open source linux monitoring tool, monitoring linux metrics] ---- - -> Collect and monitor the general performance Metrics of Linux operating system. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Linux SSH. The default is 22 | -| Username | SSH connection user name, optional | -| Password | SSH connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|--------------------------| -| hostname | none | Host name | -| version | none | Operating system version | -| uptime | none | System running time | - -#### Metric set：cpu - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|------------------------------------------------| -| info | none | CPU model | -| cores | cores | Number of CPU cores | -| interrupt | number | Number of CPU interrupts | -| load | none | Average load of CPU in the last 1/5/15 minutes | -| context_switch | number | Number of current context switches | -| usage | % | CPU usage | - -#### Metric set：memory - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------------------| -| total | Mb | Total memory capacity | -| used | Mb | User program memory | -| free | Mb | Free memory capacity | -| buff_cache | Mb | Memory occupied by cache | -| available | Mb | Remaining available memory capacity | -| usage | % | Memory usage | - -#### Metric set：disk - -| Metric name | Metric unit | Metric help description | -|---------------|-------------|----------------------------------------| -| disk_num | blocks | Total number of disks | -| partition_num | partitions | Total number of partitions | -| block_write | blocks | Total number of blocks written to disk | -| block_read | blocks | Number of blocks read from disk | -| write_rate | iops | Rate of writing disk blocks per second | - -#### Metric set：interface - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|------------------------------| -| interface_name | none | Network card name | -| receive_bytes | byte | Inbound data traffic(bytes) | -| transmit_bytes | byte | Outbound data traffic(bytes) | - -#### Metric set：disk_free - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| filesystem | none | File system name | -| used | Mb | Used disk size | -| 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 deleted file mode 100644 index 8373b61cec3..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/mariadb.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: mariadb -title: Monitoring：MariaDB database monitoring -sidebar_label: MariaDB database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring mariadb database metrics] ---- - -> Collect and monitor the general performance Metrics of MariaDB database. Support MariaDB5+. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by the database. The default is 3306 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-----------------|-------------|------------------------------------| -| version | none | Database version | -| port | none | Database exposure service port | -| datadir | none | Database storage data disk address | -| max_connections | none | Database maximum connections | - -#### Metric set：status - -| Metric name | Metric unit | Metric help description | -|-------------------|-------------|------------------------------------| -| threads_created | none | MariaDB created total connections | -| threads_connected | none | MariaDB connected connections | -| threads_cached | none | MariaDB current cached connections | -| threads_running | none | MariaDB current active connections | - -#### Metric set：innodb - -| Metric name | Metric unit | Metric help description | -|---------------------|-------------|------------------------------------------------------| -| innodb_data_reads | none | innodb average number of reads from files per second | -| 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 deleted file mode 100644 index f3c1ddfab55..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/memcached.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: memcached -title: Monitoring Memcached -sidebar_label: Memcached Monitor -keywords: [ open source monitoring tool, open source Memcached monitoring tool, monitoring memcached metrics ] ---- - -> Collect and monitor the general performance Metrics of Memcached. - -**Protocol Use：Memcached** - -```text -The default YML configuration for the memcache version is in compliance with 1.4.15. -You need to use the stats command to view the parameters that your memcache can monitor -``` - -### - -**1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. - -```shell -# telnet ip port -[root@server ~]# telnet localhost 11211 -Trying ::1... -Connected to localhost. -Escape character is '^]'. -stats -STAT pid 15168 -STAT uptime 11691 -STAT time 1702569246 -STAT version 1.4.15 -... -``` - -**There is help_doc: ** - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Memcached | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：server_info - -| Metric name | Metric unit | Metric help description | -|------------------|-------------|---------------------------------------------------| -| pid | | Memcache server process ID | -| uptime | s | The number of seconds the server has been running | -| version | | Memcache version | -| curr_connections | | Current number of connections | -| auth_errors | | Number of authentication failures | -| threads | | Current number of threads | -| item_size | byte | The size of the item | -| item_count | | Number of items | -| curr_items | | The total number of data currently stored | -| total_items | | The total number of data stored since startup | -| bytes | byte | The current number of bytes occupied by storage | -| cmd_get | | Get command request count | -| cmd_set | | Set command request count | -| cmd_flush | | Flush command request count | -| get_misses | | Get command misses | -| delete_misses | | Delete command misses | diff --git a/home/versioned_docs/version-v1.4.x/help/mysql.md b/home/versioned_docs/version-v1.4.x/help/mysql.md deleted file mode 100644 index 86922782e27..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/mysql.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: mysql -title: Monitoring：MySQL database monitoring -sidebar_label: MySQL database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring mysql database metrics] ---- - -> Collect and monitor the general performance Metrics of MySQL database. Support MYSQL5+. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by the database. The default is 3306 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-----------------|-------------|------------------------------------| -| version | none | Database version | -| port | none | Database exposure service port | -| datadir | none | Database storage data disk address | -| max_connections | none | Database maximum connections | - -#### Metric set：status - -| Metric name | Metric unit | Metric help description | -|-------------------|-------------|----------------------------------| -| threads_created | none | MySql created total connections | -| threads_connected | none | MySql connected connections | -| threads_cached | none | MySql current cached connections | -| threads_running | none | MySql current active connections | - -#### Metric set：innodb - -| Metric name | Metric unit | Metric help description | -|---------------------|-------------|------------------------------------------------------| -| innodb_data_reads | none | innodb average number of reads from files per second | -| 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 deleted file mode 100644 index 60ac139f827..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/nebulagraph.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: nebulaGraph -title: Monitoring NebulaGraph -sidebar_label: NebulaGraph Database -keywords: [ open source monitoring tool, open source NebulaGraph monitoring tool, monitoring NebulaGraph metrics ] ---- - -> Collect and monitor the general performance Metrics of nebulaGraph. - -**Protocol Use：nebulaGraph** - -```text -The monitoring has two parts,nebulaGraph_stats and rocksdb_stats. -nebulaGraph_stats is nebulaGraph's statistics, and rocksdb_stats is rocksdb's statistics. -``` - -### - -**1、Obtain available parameters through the stats and rocksdb stats interfaces.** - -1.1、 If you only need to get nebulaGraph_stats, you need to ensure that you have access to stats, or you'll get errors. - -The default port is 19669 and the access address is - -1.2、If you need to obtain additional parameters for rocksdb stats, you need to ensure that you have access to rocksdb -stats, otherwise an error will be reported. - -Once you connect to NebulaGraph for the first time, you must first register your Storage service in order to properly -query your data. - -**There is help_doc: ** - -**** - -The default port is 19779 and the access address is: - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| graphPort | Port of the Graph service provided by Nebula Graph | -| timePeriod | The value can be 5 seconds, 60 seconds, 600 seconds, or 3600 seconds, indicating the last 5 seconds, last 1 minute, last 10 minutes, and last 1 hour, respectively. | -| storagePort | Port of the storage service provided by Nebula Graph | -| Timeout | Allow collection response time | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：nebulaGraph_stats - -Too many indicators, related links are as follows -**** - -| Metric name | Metric unit | Metric help description | -|---------------------------------------|-------------|--------------------------------------------------------------| -| num_queries_hit_memory_watermark_rate | | The rate of statements that reached the memory watermark. | -| num_queries_hit_memory_watermark_sum | | The sum of statements that reached the memory watermark. | -| num_reclaimed_expired_sessions_sum | | Number of expired sessions actively reclaimed by the server. | -| ... | | ... | - -#### Metrics Set：rocksdb_stats - -Too many indicators, related links are as follows -**** - -| 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 deleted file mode 100644 index a5662be985f..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/nginx.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -id: nginx -title: Monitoring Nginx -sidebar_label: Nginx Monitor -keywords: [open source monitoring tool, open source java monitoring tool, monitoring nginx metrics] ---- - -> Collect and monitor the general performance Metrics of Nginx. - -**Protocol Use：Nginx** - -### Need Enable `ngx_http_stub_status_module` And `ngx_http_reqstat_module` Module - -If you want to monitor information in 'Nginx' with this monitoring type, you need to modify your nginx configure file for enable the module monitor. - -### Enable `ngx_http_stub_status_module` - -1. Check if `ngx_http_stub_status_module` has been added - -```shell -nginx -V -``` - -View whether it contains `--with-http_stub_status_module`, if not, you need to recompile and install Nginx. - -2. Compile and install Nginx, add `ngx_http_stub_status_module` module - -Download Nginx and unzip it, execute the following command in the directory - -```shell - -./configure --prefix=/usr/local/nginx --with-http_stub_status_module - -make && make install -``` - -3. Modify Nginx configure file - -Modify the `nginx.conf` file and add the monitoring module exposed endpoint, as follows: - -```shell -# modify nginx.conf -server { - listen 80; # port - server_name localhost; - location /nginx-status { - stub_status on; - access_log on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts - } -} -``` - -4. Reload Nginx - -```shell - -nginx -s reload -``` - -5. Access `http://localhost/nginx-status` in the browser to view the Nginx monitoring status information. - -### Enable `ngx_http_reqstat_module` - -```shell -# install `ngx_http_reqstat_module` -wget https://github.com/zls0424/ngx_req_status/archive/master.zip -O ngx_req_status.zip - -unzip ngx_req_status.zip - -patch -p1 < ../ngx_req_status-master/write_filter.patch - -./configure --prefix=/usr/local/nginx --add-module=/path/to/ngx_req_status-master - -make -j2 - -make install -``` - -2. Modify Nginx configure file - -update `nginx.conf` file, add status module exposed endpoint, as follows: - -```shell -# modify nginx.conf -http { - req_status_zone server_name $server_name 256k; - req_status_zone server_addr $server_addr 256k; - - req_status server_name server_addr; - - server { - location /req-status { - req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts - } - } -} -``` - -3. Reload Nginx - -```shell - -nginx -s reload -``` - -4. Access `http://localhost/req-status` in the browser to view the Nginx monitoring status information. - -**Refer Doc: ** - -**⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Nginx | -| Timeout | Allow collection response time | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：nginx_status - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-----------------------------------------| -| accepts | | Accepted connections | -| handled | | Successfully processed connections | -| active | | Currently active connections | -| dropped | | Discarded connections | -| requests | | Client requests | -| reading | | Connections performing read operations | -| writing | | Connections performing write operations | -| waiting | | Waiting connections | - -#### Metrics Set：req_status - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|--------------------------------| -| zone_name | | Group category | -| key | | Group name | -| max_active | | Maximum concurrent connections | -| max_bw | kb | Maximum bandwidth | -| traffic | kb | Total traffic | -| requests | | Total requests | -| active | | Current concurrent connections | -| bandwidth | kb | Current bandwidth | diff --git a/home/versioned_docs/version-v1.4.x/help/ntp.md b/home/versioned_docs/version-v1.4.x/help/ntp.md deleted file mode 100644 index fc7f7925ca6..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/ntp.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: ntp -title: Monitoring NTP -sidebar_label: NTP Monitor -keywords: [ open source monitoring tool, open source NTP monitoring tool, monitoring NTP metrics ] ---- - -> Collect and monitor the general performance Metrics of NTP. - -**Protocol Use：NTP** - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：summary - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|------------------------------------------------------------------------------------------| -| responseTime | ms | The time it takes for the NTP server to respond to a request). | -| time | ms | The current time reported by the NTP server). | -| date | | The date corresponding to the current time reported by the NTP server). | -| offset | ms | The time difference between the NTP server's clock and the client's clock). | -| delay | ms | The time it takes for a request to reach the NTP server and for the response to return). | -| version | | The version number of the NTP protocol used by the server). | -| mode | | The operating mode of the NTP server, such as client, server, or broadcast). | -| stratum | | The stratumevel of the NTP server, indicating its distance from a reference clock). | -| referenceId | | An identifier that indicates the reference clock or time source used by the NTP server). | -| precision | | The precision of the NTP server's clock, indicating its accuracy). | diff --git a/home/versioned_docs/version-v1.4.x/help/opengauss.md b/home/versioned_docs/version-v1.4.x/help/opengauss.md deleted file mode 100644 index 3490bb8b003..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/opengauss.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: opengauss -title: OpenGauss Database Monitor -sidebar_label: OpenGauss Database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring opengauss database metrics] ---- - -> Collect and monitor the general performance Metrics of OpenGauss database. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by the database. The default is 5432 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-----------------|-------------|-------------------------------------------| -| server_version | none | Version number of the database server | -| port | none | Database server exposure service port | -| server_encoding | none | Character set encoding of database server | -| data_directory | none | Database storage data disk address | -| max_connections | connections | Database maximum connections | - -#### Metric set：state - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| name | none | Database name, or share-object is a shared object | -| conflicts | times | The number of queries canceled in the database due to a conflict with recovery | -| deadlocks | number | Number of deadlocks detected in the database | -| blks_read | times | The number of disk blocks read in the database | -| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the PostgreSQL buffer, not in the operating system file system buffer) | -| blk_read_time | ms | Time spent by the backend reading data file blocks in the database | -| blk_write_time | ms | Time spent by the backend writing data file blocks in the database | -| stats_reset | none | The last time these statistics were reset | - -#### Metric set：activity - -| 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 deleted file mode 100644 index 978e6736620..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/oracle.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: oracle -title: Monitoring：ORACLE database monitoring -sidebar_label: ORACLE database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring oracle database metrics] ---- - -> Collect and monitor the general performance Metrics of ORACLE database. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by the database. The default is 1521 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|------------------|-------------|-------------------------| -| database_version | none | Database version | -| database_type | none | Database type | -| hostname | none | Host name | -| instance_name | none | Database instance name | -| startup_time | none | Database start time | -| status | none | Database status | - -#### Metric set：tablespace - -| Metric name | Metric unit | Metric help description | -|-----------------|-------------|-------------------------| -| file_id | none | File ID | -| file_name | none | File name | -| tablespace_name | none | Table space name | -| status | none | Status | -| bytes | MB | Size | -| blocks | none | Number of blocks | - -#### Metric set：user_connect - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|---------------------------| -| username | none | Username | -| counts | number | Current connection counts | - -#### Metric set：performance - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-----------------------------| -| 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 deleted file mode 100644 index bed89d53dcf..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/ping.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: ping -title: Monitoring：PING connectivity -sidebar_label: PING connectivity -keywords: [open source monitoring tool, open source network monitoring tool, monitoring ping metrics] ---- - -> Ping the opposite end HOST address and judge its connectivity. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Ping timeout | Set the timeout when Ping does not respond to data, unit:ms, default: 3000ms | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：summary - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|-------------------------| -| responseTime | ms | Website response time | - -### Common Problem - -1. Ping connectivity monitoring exception when installing hertzbeat for package deployment. - The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。 - -> The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened. -> When you install HertzBeat via DockerDocker root is enabled by default. No such problem. -> See diff --git a/home/versioned_docs/version-v1.4.x/help/pop3.md b/home/versioned_docs/version-v1.4.x/help/pop3.md deleted file mode 100644 index c73884a0afe..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/pop3.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: pop3 -title: Monitoring POP3 -sidebar_label: POP3 Monitor -keywords: [open source monitoring tool, open source java monitoring tool, monitoring POP3 metrics] ---- - -> Collect and monitor the general performance Metrics of POP3. - -**Protocol Use：POP3** - -### Enable POP3 Service - -If you want to monitor information in 'POP3' with this monitoring type, you just need to open `POP3` service in your mail server. - -**1、Open `POP3` Service:** - -```text -以qq邮箱为例【其它邮箱类似】： - 1. 点击`设置`选项 - 2. 选择`账号` - 3. 找到开启SMTP/POP3/IMAP选项，并开启 - 4. 得到POP3服务器域名，端口号，以及授权码【开启SMTP/POP3/IMAP服务后，qq邮箱提供】 - 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 -``` - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by POP3 | -| SSL | POP3 If enabled SSL | -| Timeout | Allow collection response time | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：email_status - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|-----------------------------------------| -| email_count | | Number of emails | -| mailbox_size | kb | The total size of emails in the mailbox | diff --git a/home/versioned_docs/version-v1.4.x/help/port.md b/home/versioned_docs/version-v1.4.x/help/port.md deleted file mode 100644 index 8d58ac1f5c5..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/port.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: port -title: Monitoring：port availability -sidebar_label: Port availability -keywords: [open source monitoring tool, open source port monitoring tool, monitoring port metrics] ---- - -> Judge whether the exposed port of the opposite end service is available, then judge whether the opposite end service is available, and collect Metrics such as response time for monitoring. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 | -| Connection timeout | Waiting timeout for port connection, unit:ms, default: 3000ms | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：summary - -| 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 deleted file mode 100644 index 5191f7d325d..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/postgresql.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: postgresql -title: Monitoring：PostgreSQL database monitoring -sidebar_label: PostgreSQL database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring postgresql database metrics] ---- - -> Collect and monitor the general performance Metrics of PostgreSQL database. Support PostgreSQL 10+. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by the database. The default is 5432 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-----------------|-------------|-------------------------------------------| -| server_version | none | Version number of the database server | -| port | none | Database server exposure service port | -| server_encoding | none | Character set encoding of database server | -| data_directory | none | Database storage data disk address | -| max_connections | connections | Database maximum connections | - -#### Metric set：state - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| name | none | Database name, or share-object is a shared object | -| conflicts | times | The number of queries canceled in the database due to a conflict with recovery | -| deadlocks | number | Number of deadlocks detected in the database | -| blks_read | times | The number of disk blocks read in the database | -| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the PostgreSQL buffer, not in the operating system file system buffer) | -| blk_read_time | ms | Time spent by the backend reading data file blocks in the database | -| blk_write_time | ms | Time spent by the backend writing data file blocks in the database | -| stats_reset | none | The last time these statistics were reset | - -#### Metric set：activity - -| 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 deleted file mode 100644 index e49d572ee72..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/rabbitmq.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -id: rabbitmq -title: Monitoring RabbitMQ -sidebar_label: RabbitMQ Monitor -keywords: [open source monitoring tool, open source rabbitmq monitoring tool, monitoring rabbitmq metrics] ---- - -> Monitoring the running status of RabbitMQ message middleware, nodes, topics and other related metrics. - -### Pre-monitoring Operations - -> HertzBeat uses RabbitMQ Management's Rest Api to collect RabbitMQ metric data. -> Therefore, you need to enable the Management plug-in in your RabbitMQ environment - -1. Open the Management plugin, or use the self-opening version - -```shell -rabbitmq-plugins enable rabbitmq_management -``` - -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. - -### Configuration parameters - -| Parameter name | Parameter help description | -|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). | -| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. | -| Port | The HTTP port provided by RabbitMQ Management, the default is 15672. | -| Username | Username used for interface Basic authentication | -| Password | The password used for interface Basic authentication | -| Timeout | HTTP request query timeout | -| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful | -| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here | - -### Collect Metrics - -#### metrics: overview - -| Metric Name | Metric Unit | Metric Description | -|--------------------|-------------|------------------------------------| -| product_version | None | Product Version | -| product_name | None | Product name | -| rabbitmq_version | none | rabbitmq version | -| management_version | None | rabbitmq management plugin version | -| erlang_version | None | erlang version | -| cluster_name | None | Cluster name | -| rates_mode | None | rates mode | - -#### metrics: object_totals - -| Metric Name | Metric Unit | Metric Description | -|-------------|-------------|-----------------------------| -| channels | none | total number of channels | -| connections | none | total number of connections | -| consumers | none | total number of consumers | -| exchanges | none | total number of exchanges | -| queues | none | total number of queues | - -#### metrics: nodes - -| Metric Name | Metric Unit | Metric Description | -|--------------------|-------------|-----------------------------------------------------------| -| name | None | The node name | -| type | None | The node type | -| running | None | Running state | -| os_pid | None | Pid in OS | -| mem_limit | MB | Memory usage high watermark | -| mem_used | MB | Total amount of memory used | -| fd_total | None | File descriptors available | -| fd_used | None | File descriptors used | -| sockets_total | None | Sockets available | -| sockets_used | None | Sockets used | -| proc_total | None | Erlang process limit | -| proc_used | None | Erlang processes used | -| disk_free_limit | GB | Free disk space low watermark | -| disk_free | GB | Free disk space | -| gc_num | None | GC runs | -| gc_bytes_reclaimed | MB | Bytes reclaimed by GC | -| context_switches | None | Context_switches num | -| io_read_count | None | Total number of read operations | -| io_read_bytes | KB | Total data size read into disk | -| io_read_avg_time | ms | Average read operation time in milliseconds | -| io_write_count | None | Total disk write operations | -| io_write_bytes | KB | Total amount of data written to disk | -| io_write_avg_time | ms | Average time of each disk write operation in milliseconds | -| io_seek_count | None | total seek operation | -| io_seek_avg_time | ms | average seek operation time, in milliseconds | -| io_sync_count | None | total amount of fsync operations | -| io_sync_avg_time | ms | Average time of fsync operation in milliseconds | -| connection_created | None | connection created num | -| connection_closed | None | connection closed num | -| channel_created | None | channel created num | -| channel_closed | None | channel closed num | -| queue_declared | None | queue declared num | -| queue_created | None | queue created num | -| queue_deleted | None | queue deleted num | -| connection_closed | None | connection closed num | - -#### metrics: queues - -| Metric Name | Metric Unit | Metric Description | -|------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------| -| name | None | The name of the queue with non-ASCII characters escaped as in C. | -| node | None | The queue on the node name | -| state | None | The state of the queue. Normally "running", but may be "{syncing, message_count}" if the queue is synchronising. | -| type | None | Queue type, one of: quorum, stream, classic. | -| vhost | None | vhost path | -| auto_delete | None | Whether the queue will be deleted automatically when no longer used | -| policy | None | Effective policy name for the queue. | -| consumers | None | Number of consumers. | -| memory | B | Bytes of memory allocated by the runtime for the queue, including stack, heap and internal structures. | -| messages_ready | None | Number of messages ready to be delivered to clients | -| messages_unacknowledged | None | Number of messages delivered to clients but not yet acknowledged | -| messages | None | Sum of ready and unacknowledged messages (queue depth) | -| messages_ready_ram | None | Number of messages from messages_ready which are resident in ram | -| messages_persistent | None | Total number of persistent messages in the queue (will always be 0 for transient queues) | -| message_bytes | B | Sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead | -| message_bytes_ready | B | Like message_bytes but counting only those messages ready to be delivered to clients | -| 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 deleted file mode 100644 index 0a0c9f77a65..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/redis.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -id: redis -title: 监控：REDIS数据库监控 -sidebar_label: REDIS数据库 -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] ---- - -> 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：server - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------|------|-----------------------------------------------| -| redis_version | 无 | Redis 服务器版本 | -| redis_git_sha1 | 无 | Git SHA1 | -| redis_git_dirty | 无 | Git dirty flag | -| redis_build_id | 无 | redis 构建的id | -| redis_mode | 无 | redis模式（包括standalone, sentinel, cluster） | -| os | 无 | Redis 服务器的宿主操作系统 | -| arch_bits | 无 | 架构（32 或 64 位） | -| multiplexing_api | 无 | Redis使用的事件循环机制 | -| atomicvar_api | 无 | Redis使用的原子 API | -| gcc_version | 无 | 用于编译Redis服务器的GCC编译器版本 | -| process_id | 无 | 服务器进程的PID | -| process_supervised | 无 | 受监管系统（包括：upstart、systemd、unknown、no） | -| run_id | 无 | 标识Redis服务器的随机值（由Sentinel和Cluster使用） | -| tcp_port | 无 | TCP/IP侦听端口 | -| server_time_usec | 无 | 微秒级精度的基于时间的系统时间 | -| uptime_in_seconds | 无 | 自Redis服务器启动后的秒数 | -| uptime_in_days | 无 | 自Redis服务器启动后的天数 | -| hz | 无 | 服务器的当前频率设置，redis相关定时任务的执行频率（如清除过期key，关闭超时客户端） | -| configured_hz | 无 | 服务器配置的频率设置 | -| lru_clock | 无 | 时钟每分钟递增，用于LRU管理 | -| executable | 无 | 服务器可执行文件的路径 | -| config_file | 无 | 配置文件的路径 | -| io_threads_active | 无 | 指示I/O线程是否处于活动状态的标志 | -| shutdown_in_milliseconds | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。 | - -#### 指标集合：clients - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------------|------|--------------------------------------------------------------------------------| -| connected_clients | 无 | 客户端连接数（不包括来自副本的连接） | -| cluster_connections | 无 | 群集总线使用的套接字数量的近似值 | -| maxclients | 无 | maxclients配置指令的值。这是connected_clients、connected_slave和cluster_connections之和的上限。 | -| client_recent_max_input_buffer | byte | 当前客户端连接中最大的输入缓冲区 | -| client_recent_max_output_buffer | byte | 当前客户端连接中最大的输出缓冲区 | -| blocked_clients | 无 | 阻塞呼叫挂起的客户端数（BLPOP、BRPOP、BRPOPLPUSH、BLMOVE、BZPOPMIN、BZPOPMAX） | -| tracking_clients | 无 | 正在跟踪的客户端数（CLIENT TRACKING） | -| clients_in_timeout_table | 无 | 客户端超时表中的客户端数 | - -#### 指标集合：memory - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------|----------|-----------------------------------------------------------------------------------------------| -| used_memory | byte | Redis使用其分配器（标准libc、jemalloc或tcmalloc等替代分配器）分配的总字节数 | -| used_memory_human | GB/MB/KB | 上一个值的人类可读表示 | -| used_memory_rss | byte | 操作系统看到的Redis分配的字节数（也称为驻留集大小）。这是top（1）和ps（1）等工具报告的数字 | -| used_memory_rss_human | GB/MB/KB | 上一个值的人类可读值 | -| used_memory_peak | byte | Redis消耗的峰值内存（字节） | -| used_memory_peak_human | GB/MB/KB | 上一个值的人类可读值 | -| used_memory_peak_perc | 无 | used_memory_peak 与used_memory百分比 | -| used_memory_overhead | byte | 服务器分配用于管理其内部数据结构的所有开销的字节总和 | -| used_memory_startup | byte | Redis在启动时消耗的初始内存量（字节） | -| used_memory_dataset | byte | 数据集的字节大小（used_memory - used_memory_overhead） | -| used_memory_dataset_perc | 无 | 已用内存数据集占净内存使用量的百分比（used_memory_dataset / (used_memory - used_memory_startup)） | -| allocator_allocated | byte | 从分配器分配的总字节数，包括内部碎片。通常与使用的内存相同 | -| allocator_active | byte | 分配器活动页中的总字节数，包括外部碎片 | -| allocator_resident | byte | 分配器中驻留的总字节数（RSS），包括可释放到操作系统的页面（通过MEMORY PURGE或仅等待） | -| total_system_memory | byte | Redis主机的内存总量 | -| total_system_memory_human | GB/MB/KB | 上一个值的人类可读值 | -| used_memory_lua | byte | Lua引擎使用的字节数 | -| used_memory_lua_human | KB | 上一个值的人类可读值 | -| used_memory_scripts | byte | 缓存Lua脚本使用的字节数 | -| used_memory_scripts_human | GB/MB/KB | 上一值的人类可读值 | -| number_of_cached_scripts | 无 | 缓存的lua脚本数量 | -| maxmemory | byte | maxmemory配置指令的值 | -| maxmemory_human | GB/MB/KB | 上一个值的人类可读值 | -| maxmemory_policy | 无 | 当达到maxmemory时的淘汰策略 | -| allocator_frag_ratio | 无 | allocator_active 和 allocator_allocated之间的比率这是真实（外部）碎片度量（不是mem_fragmentation_ratio） | -| allocator_frag_bytes | byte | allocator_active 和 allocator_allocated 之间的差值。 | -| allocator_rss_ratio | | 从操作系统角度看, 内存分配器碎片比例 | -| allocator_rss_bytes | byte | allocator_resident 和 allocator_active之间的差值 | -| rss_overhead_ratio | 无 | used_memory_rss和allocator_resident之间的比率，这包括与分配器或堆无关的RSS开销 | -| rss_overhead_bytes | byte | used_memory_rss和allocator_resident之间的增量 | -| mem_fragmentation_ratio | 无 | used_memory_rss和used_memory之间的比率，注意，这不仅包括碎片，还包括其他进程开销（请参阅allocator_* metrics），以及代码、共享库、堆栈等开销。 | -| mem_fragmentation_bytes | byte | used_memory_rss和used_memory之间的增量。注意，当总碎片字节较低（几兆字节）时，高比率（例如1.5及以上）不是问题的表现 | -| mem_not_counted_for_evict | byte | 不应驱逐的内存大小,以字节为单位。这基本上是瞬时复制和AOF缓冲区。 | -| mem_replication_backlog | byte | 复制backlog的内存大小, 以字节为单位 | -| mem_clients_slaves | 无 | 副本客户端使用的内存-从Redis 7.0开始，副本缓冲区与复制积压工作共享内存，因此当副本不触发内存使用增加时，此字段可以显示0。 | -| mem_clients_normal | 无 | 普通客户端使用的内存 | -| mem_aof_buffer | 无 | 用于AOF和AOF重写缓冲区的临时大小 | -| mem_allocator | 无 | 内存分配器，在编译时选择。 | -| active_defrag_running | 无 | 启用activedefrag时，这表示碎片整理当前是否处于活动状态，以及它打算使用的CPU百分比。 | -| lazyfree_pending_objects | 无 | 等待释放的对象数（使用ASYNC选项调用UNLINK或FLUSHDB和FLUSHOLL） | -| lazyfreed_objects | 无 | 已延迟释放的对象数。 | - -#### 指标集合：persistence - -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------------------------|--------|-----------------------------------------------------------------------------------------------------| -| loading | 无 | 服务器是否正在进行持久化 0 - 否 1 -是 | -| current_cow_size | byte | 运行子fork时写入时复制内存的大小（以字节为单位） | -| current_cow_size_age | second | current_cow_size值的年龄（以秒为单位） | -| current_fork_perc | 无 | 当前fork进程的百分比，对于AOF和RDB的fork，它是current_save_keys_processed占current_save_keys_total的百分比 | -| current_save_keys_processed | 无 | 当前保存操作处理的key的数量 | -| current_save_keys_total | 无 | 当前保存操作开始时的key的数量 | -| rdb_changes_since_last_save | 无 | 离最近一次成功生成rdb文件，写入命令的个数，即有多少个写入命令没有持久化 | -| rdb_bgsave_in_progress | 无 | 服务器是否正在创建rdb文件 0 - 否 1 - 是 | -| rdb_last_save_time | second | 最近一次创建rdb文件的时间戳,单位秒 | -| rdb_last_bgsave_status | 无 | 最近一次rdb持久化是否成功 ok 成功 | -| rdb_last_bgsave_time_sec | second | 最近一次成功生成rdb文件耗时秒数 | -| rdb_current_bgsave_time_sec | 无 | 如果服务器正在创建rdb文件，那么这个字段记录的就是当前的创建操作已经耗费的秒数 | -| rdb_last_cow_size | 无 | RDB过程中父进程与子进程相比执行了多少修改(包括读缓冲区，写缓冲区，数据修改等) | -| aof_enabled | 无 | 是否开启了AOF 0 - 否 1 - 是 | -| aof_rewrite_in_progress | 无 | 标识aof的rewrite操作是否在进行中 0 - 否 1- 是 | -| aof_rewrite_scheduled | 无 | rewrite任务计划，当客户端发送bgrewriteaof指令，如果当前rewrite子进程正在执行，那么将客户端请求的bgrewriteaof变为计划任务，待aof子进程结束后执行rewrite | -| aof_last_rewrite_time_sec | 无 | 最近一次aof rewrite耗费的时长 | -| aof_current_rewrite_time_sec | second | 如果rewrite操作正在进行，则记录所使用的时间，单位秒 | -| aof_last_bgrewrite_status | 无 | 上次 bgrewrite aof 操作的状态 ok 成功 | -| aof_last_write_status | 无 | 上次aof写入状态 | -| aof_last_cow_size | 无 | AOF过程中父进程与子进程相比执行了多少修改(包括读缓冲区，写缓冲区，数据修改等) | -| module_fork_in_progress | 无 | 指示fork模块正在进行的标志 | -| module_fork_last_cow_size | 无 | 上一次fork操作期间写入时复制内存的字节大小 | - -#### 指标集合：stats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------------|------|----------------------------------------------------| -| total_connections_received | 无 | 服务器接受的连接总数 | -| total_commands_processed | 无 | 服务器处理的命令总数 | -| instantaneous_ops_per_sec | 无 | 每秒处理的命令数 | -| total_net_input_bytes | byte | 从网络读取的字节总数 | -| total_net_output_bytes | byte | 写入网络的总字节数 | -| instantaneous_input_kbps | KB/S | 网络每秒的读取速率（KB/秒） | -| instantaneous_output_kbps | KB/S | 网络每秒的写入速率（KB/秒） | -| rejected_connections | 无 | 由于maxclients限制而拒绝的连接数 | -| sync_full | 无 | 具有副本的完整重新同步数 | -| sync_partial_ok | 无 | 接受的部分重新同步请求数 | -| sync_partial_err | 无 | 被拒绝的部分重新同步请求数 | -| expired_keys | 无 | 过期的key总数 | -| expired_stale_perc | 无 | 可能过期key的百分比 | -| expired_time_cap_reached_count | 无 | 活动过期周期提前停止的次数 | -| expire_cycle_cpu_milliseconds | 无 | 活动到期周期所花费的累计时间 | -| evicted_keys | 无 | 由于最大内存限制而收回key的数量 | -| keyspace_hits | 无 | 在主dict 中成功查找key的次数 | -| keyspace_misses | 无 | 在主dict 中未查到key的次数 | -| pubsub_channels | 无 | 客户端使用 pub/sub 频道的总和 | -| pubsub_patterns | 无 | 客户端使用 pub/sub 模式的全局数量 | -| latest_fork_usec | 无 | 最后一次fork操作的持续时间（以微秒为单位） | -| total_forks | 无 | 自服务器启动以来的fork操作总数 | -| migrate_cached_sockets | 无 | 为MIGRATE目的打开的socket数量 | -| slave_expires_tracked_keys | 无 | trace key 到期的数量（仅适用于可写副本） | -| active_defrag_hits | 无 | 主动碎片整理命中次数 | -| active_defrag_misses | 无 | 主动碎片整理未命中次数 | -| active_defrag_key_hits | 无 | 主动碎片整理key命中次数 | -| active_defrag_key_misses | 无 | 主动碎片整理key未命中次数 | -| tracking_total_keys | 无 | key 查询的总数 | -| tracking_total_items | 无 | item查询的总数 | -| tracking_total_prefixes | 无 | 前缀查询的总数 | -| unexpected_error_replies | 无 | 意外错误回复数，即AOF加载或复制中的错误类型 | -| total_error_replies | 无 | 发出的错误回复总数，即被拒绝的命令（命令执行之前的错误）和失败的命令（在命令执行过程中的错误）的总和 | -| dump_payload_sanitizations | 无 | 参考sanitize-dump-payload配置 | -| total_reads_processed | 无 | 正在读取的请求数 | -| total_writes_processed | 无 | 正在写入的请求数 | -| io_threaded_reads_processed | 无 | 正在读取的线程数 | -| io_threaded_writes_processed | 无 | 正在写入的线程数 | - -#### 指标集合：replication - -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------------------------------|------|-------------------------------------------------------------------------------------| -| role | 无 | 节点角色 master 主节点 slave 从节点 | -| connected_slaves | 无 | 连接的从节点数 | -| master_failover_state | 无 | 正在进行的故障切换的状态（如果有） | -| master_replid | 无 | 实例启动的随机字符串 | -| master_replid2 | 无 | 故障切换后用于PSYNC的辅助复制ID | -| master_repl_offset | 无 | 主从同步偏移量 | -| second_repl_offset | 无 | 接受从服务ID的最大偏移量 | -| repl_backlog_active | 无 | 表示从服务挤压处于活动状态 | -| repl_backlog_size | byte | 从服务积压缓冲区的总大小（字节） | -| repl_backlog_first_byte_offset | 无 | 复制缓冲区里偏移量的大小 | -| repl_backlog_histlen | 无 | 此值等于 master_repl_offset - repl_backlog_first_byte_offset,该值不会超过repl_backlog_size的大小 | - -#### 指标集合：cpu - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------|------|------------------------| -| used_cpu_sys | 无 | Redis主进程在内核态所占用CPU时钟总和 | -| used_cpu_user | 无 | Redis主进程在用户态所占用CPU时钟总和 | -| used_cpu_sys_children | 无 | Redis子进程在内核态所占用CPU时钟总和 | -| used_cpu_user_children | 无 | Redis子进程在用户态所占用CPU时钟总和 | -| used_cpu_sys_main_thread | 无 | Redis服务器主线程消耗的内核CPU | -| used_cpu_user_main_thread | 无 | Redis服务器主线程消耗的用户CPU | - -#### 指标集合：errorstats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------|------|-----------| -| errorstat_ERR | 无 | 错误累计出现的次数 | -| errorstat_MISCONF | 无 | | - -#### 指标集合：cluster - -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------|------|--------------------| -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是 | - -#### 指标集合：commandstats - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|------|---------------------------------------------------------------------------------------------------------------------------| -| cmdstat_set | 无 | set命令的统计信息，calls: 累计调用该命令的次数；usec: 调用该命令的累计耗时,单位微秒；usec_per_call: 调用该命令的平均耗时；rejected_call: 拒绝执行的次数；failed_calls: 调用失败的次数 | -| cmdstat_get | 无 | get命令的统计信息 | -| cmdstat_setnx | 无 | setnx命令的统计信息 | -| cmdstat_hset | 无 | hset命令的统计信息 | -| cmdstat_hget | 无 | hget命令的统计信息 | -| cmdstat_lpush | 无 | lpush命令的统计信息 | -| cmdstat_rpush | 无 | rpush命令的统计信息 | -| cmdstat_lpop | 无 | lpop命令的统计信息 | -| cmdstat_rpop | 无 | rpop命令的统计信息 | -| cmdstat_llen | 无 | llen命令的统计信息 | diff --git a/home/versioned_docs/version-v1.4.x/help/shenyu.md b/home/versioned_docs/version-v1.4.x/help/shenyu.md deleted file mode 100644 index aa4a43a8d5c..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/shenyu.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -id: shenyu -title: Monitoring：Apache ShenYu API Gateway -sidebar_label: Apache ShenYu -keywords: [open source monitoring tool, open source apache shenyu monitoring tool, monitoring apache shenyu metrics] ---- - -> monitor ShenYu running status(JVM-related), include request response and other related metrics. - -## Pre-monitoring operations - -Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 - -Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) - -Two Steps Mainly: - -1. add metrics plugin dependency in gateway's pom.xml. - -```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - -``` - -2. modify this config in shenyu gateway yaml. - -```yaml -shenyu: - metrics: - enabled: false #false is close, true is open - name : prometheus - host: 127.0.0.1 - port: 8090 - jmxConfig: - props: - jvm_enabled: true #enable jvm monitoring -``` - -Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond to prometheus format data. - -### Configuration parameters - -| Parameter name | Parameter help description | -|--------|----------------------------------------- --------------| -| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). | -| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. | -| Port | The port provided by the gateway Metric interface, the default is 8090. | -| Timeout | HTTP request response timeout | -| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful | -| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here | - -### Collect metrics - -#### Index collection: shenyu_request_total - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|------------------------------------------| -| value | None | Collect all requests from ShenYu gateway | - -#### Metric collection: shenyu_request_throw_created - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------------------------------------------| -| value | None | Collect the number of abnormal requests from ShenYu Gateway | - -#### Metric collection: process_cpu_seconds_total - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------------------------| -| value | none | total user and system CPU elapsed seconds | - -#### Metric collection: process_open_fds - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|---------------------------------| -| value | none | number of open file descriptors | - -#### Metric collection: process_max_fds - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-----------------------------------------| -| value | none | maximum number of open file descriptors | - -#### Metric collection: jvm_info - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------| -| runtime | none | JVM version information | -| vendor | none | JVM version information | -| version | None | JVM version information | - -#### Metric collection: jvm_memory_bytes_used - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|------------------------------------------| -| area | None | JVM memory area | -| value | MB | used size of the given JVM memory region | - -#### Metric collection: jvm_memory_pool_bytes_used - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|----------------------------------------| -| pool | None | JVM memory pool | -| value | MB | used size of the given JVM memory pool | - -#### Metric collection: jvm_memory_pool_bytes_committed - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------------------------------| -| pool | None | JVM memory pool | -| value | MB | The committed size of the given JVM memory pool | - -#### Metric collection: jvm_memory_pool_bytes_max - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|-------------------------------------------------------| -| pool | None | JVM memory pool | -| value | MB | The maximum size of the memory pool for the given JVM | - -#### Metric collection: jvm_threads_state - -| Metric Name | Metric Unit | Metric Help Description | -|-------------|-------------|---------------------------------------------------------| -| 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 deleted file mode 100644 index 4be044bc090..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/smtp.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: smtp -title: Monitoring SMTP -sidebar_label: SMTP Monitor -keywords: [ open source monitoring tool, open source SMTP monitoring tool, monitoring SMTP metrics ] ---- - -> Collect and monitor the general performance Metrics of SMTP. - -```text -Determine whether the server is available through the hello command in SMTP -``` - -> see - -**Protocol Use：SMTP** - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by SMTP | -| Email | Your email name, parameters for the hello command | -| Timeout | Allow collection response time | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：summary - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|----------------------------------------------------------------| -| responseTime | ms | The time it takes for the SMTP server to respond to a request. | -| response | | Response Status. | -| smtpBanner | | Banner of SMTP server. | -| heloInfo | | Response information returned by helo. | diff --git a/home/versioned_docs/version-v1.4.x/help/spark.md b/home/versioned_docs/version-v1.4.x/help/spark.md deleted file mode 100644 index 8bc045fc9a1..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/spark.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -id: spark -title: Monitoring Spark -sidebar_label: Spark Monitor -keywords: [open source monitoring tool, open source java spark monitoring tool, monitoring spark metrics] ---- - -> Collect and monitor the general performance Metrics of Spark. - -**Protocol Use：JMX** - -### Spark App Enable JMX Protocol - -1. Add Spark `VM options` When Start Server ⚠️ customIP - -Refer: - -**监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** -**如果都要监控，需要根据以下步骤来配置** - -## 第一步 - -**修改$SPARK_HOME/conf/spark-env.sh，添加以下语句：** - -```shell -# JMX Port to use -SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false" - -# export SPARK_DAEMON_JAVA_OPTS="$SPARK_DAEMON_JAVA_OPTS -Dcom.sun.management.jmxremote.port=$JMX_PORT " -export SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.port=8712 " -``` - -语句中有$JMX_PORT，这个的值可以自定义，也可以获取一个随机数作为端口号。 -如果端口自定义为一个具体的值，而 spark 的 Master 和其中之一的 Worker 在同一台机器上，会出现端口冲突的情况。 - -## 第二步 - -**vim $SPARK_HOME/conf/metrics.properties 添加如下内容** - -```shell -*.sink.jmx.class=org.apache.spark.metrics.sink.JmxSink -master.source.jvm.class=org.apache.spark.metrics.source.JvmSource -worker.source.jvm.class=org.apache.spark.metrics.source.JvmSource -driver.source.jvm.class=org.apache.spark.metrics.source.JvmSource -executor.source.jvm.class=org.apache.spark.metrics.source.JvmSource -``` - -## 第三步 - -**vim $SPARK_HOME/conf/spark-defaults.conf，添加以下项为driver和executor设置监控端口，在有程序运行的情况下，此端口会被打开。** - -```shell -spark.metrics.conf /opt/bigdata/spark/conf/metrics.properties -spark.driver.extraJavaOptions -XX:+PrintGCDetails -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.mana -gement.jmxremote.port=8712 - -spark.executor.extraJavaOptions -XX:+PrintGCDetails -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.mana -gement.jmxremote.port=8711 -``` - -在spark的Master和Worker正常运行以及spark-submit提交了一个程序的情况下，可以从linux中查询出端口号码。 - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by JMX | -| Username | JMX connection user name, optional | -| Password | JMX connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：memory_pool - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：code_cache (Only Support JDK8) - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：class_loading - -| Metric name | Metric unit | Metric help description | -|-----------------------|-------------|--------------------------| -| LoadedClassCount | | Loaded Class Count | -| TotalLoadedClassCount | | Total Loaded Class Count | -| UnloadedClassCount | | Unloaded Class Count | - -#### Metrics Set：thread - -| Metric name | Metric unit | Metric help description | -|-------------------------|-------------|----------------------------| -| TotalStartedThreadCount | | Total Started Thread Count | -| ThreadCount | | Thread Count | -| PeakThreadCount | | Peak Thread Count | -| DaemonThreadCount | | Daemon Thread Count | -| CurrentThreadUserTime | ms | Current Thread User Time | -| CurrentThreadCpuTime | ms | Current Thread Cpu Time | diff --git a/home/versioned_docs/version-v1.4.x/help/spring_gateway.md b/home/versioned_docs/version-v1.4.x/help/spring_gateway.md deleted file mode 100644 index 7f27b7fe8ef..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/spring_gateway.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: spring_gateway -Title: Monitoring Spring Gateway -sidebar_label: Spring Gateway -keywords: [open source monitoring tool, open source spring gateway monitoring tool, monitoring spring gateway metrics] ---- - -> Collect and monitor the general performance metrics exposed by the SpringBoot actuator. - -## Pre-monitoring operations - -If you want to monitor information in 'Spring Gateway' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. - -**1、Add POM .XML dependencies:** - -```xml - - org.springframework.boot - spring-boot-starter-actuator - -``` - -**2. Modify the YML configuration exposure metric interface:** - -```yaml -management: - endpoint: - gateway: - enabled: true # default value - endpoints: - web: - exposure: - include: '*' - enabled-by-default: on -``` - -### Configure parameters - -| Parameter name | Parameter Help describes the | -|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | -| Monitoring Name | A name that identifies this monitoring that needs to be unique. | -| Port | The default port provided by the database is 8080. | -| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 | -| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | -| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful | -| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | - -### Collect metrics - -#### metric Collection: Health - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|--------------------------| -| status | None | Service health: UP, Down | - -#### metric Collection: enviroment - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|-----------------------------------------------| -| profile | None | The application runs profile: prod, dev, test | -| port | None | Apply the exposed port | -| os | None | Run the operating system | -| os_arch | None | Run the operating system architecture | -| jdk_vendor | None | jdk vendor | -| jvm_version | None | jvm version | - -#### metric Collection: threads - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|----------------------------------|-------------------| -| state | None | Thread status | -| number | None | This thread state corresponds to | number of threads | - -#### metric Collection: memory_used - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|--------------------------------------| -| space | None | Memory space name | -| mem_used | MB | This space occupies a memory size of | - -#### metric Collection: route_info - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|---------------------------------------| -| route_id | None | Route id | -| predicate | None | This is a routing matching rule | -| uri | None | This is a service resource identifier | -| order | None | The priority of this route | diff --git a/home/versioned_docs/version-v1.4.x/help/springboot2.md b/home/versioned_docs/version-v1.4.x/help/springboot2.md deleted file mode 100644 index 08029dc23b5..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/springboot2.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: springboot2 -Title: Monitoring SpringBoot 2.0 -sidebar_label: SpringBoot 2.0 -keywords: [open source monitoring tool, open source springboot2 monitoring tool, monitoring springboot2 metrics] ---- - -> Collect and monitor the general performance metrics exposed by the SpringBoot 2.0 actuator. - -## Pre-monitoring operations - -If you want to monitor information in 'SpringBoot' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. - -**1、Add POM .XML dependencies:** - -```xml - - org.springframework.boot - spring-boot-starter-actuator - -``` - -**2. Modify the YML configuration exposure metric interface:** - -```yaml -management: - endpoints: - web: - exposure: - include: '*' - enabled-by-default: on -``` - -*Note: If your project also introduces authentication related dependencies, such as springboot security, the interfaces exposed by SpringBoot Actor may be intercepted. In this case, you need to manually release these interfaces. Taking springboot security as an example, you should add the following code to the Security Configuration class:* - -```java -public class SecurityConfig extends WebSecurityConfigurerAdapter{ - @Override - protected void configure(HttpSecurity httpSecurity) throws Exception{ - httpSecurity - // Configure the interfaces to be released ----------------------------------- - .antMatchers("/actuator/**").permitAll() - .antMatchers("/metrics/**").permitAll() - .antMatchers("/trace").permitAll() - .antMatchers("/heapdump").permitAll() - // 。。。 - // For other interfaces, please refer to: https://blog.csdn.net/JHIII/article/details/126601858 ----------------------------------- - } -} -``` - -### Configure parameters - -| Parameter name | Parameter Help describes the | -|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| -| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | -| Monitoring Name | A name that identifies this monitoring that needs to be unique. | -| Port | The default port provided by the database is 8080. | -| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 | -| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | -| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful | -| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | - -### Collect metrics - -#### metric Collection: Health - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|--------------------------| -| status | None | Service health: UP, Down | - -#### metric Collection: enviroment - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|-----------------------------------------------| -| profile | None | The application runs profile: prod, dev, test | -| port | None | Apply the exposed port | -| os | None | Run the operating system | -| os_arch | None | Run the operating system architecture | -| jdk_vendor | None | jdk vendor | -| jvm_version | None | jvm version | - -#### metric Collection: threads - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|----------------------------------|-------------------| -| state | None | Thread status | -| number | None | This thread state corresponds to | number of threads | - -#### metric Collection: memory_used - -| Metric Name | metric unit | Metrics help describe | -|-------------|-------------|--------------------------------------| -| space | None | Memory space name | -| mem_used | MB | This space occupies a memory size of | diff --git a/home/versioned_docs/version-v1.4.x/help/sqlserver.md b/home/versioned_docs/version-v1.4.x/help/sqlserver.md deleted file mode 100644 index 06e19252ede..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/sqlserver.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: sqlserver -title: Monitoring：SqlServer database monitoring -sidebar_label: SqlServer database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring sqlserver database metrics] ---- - -> Collect and monitor the general performance Metrics of SqlServer database. Support SqlServer 2017+. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by the database. The default is 1433 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|-----------------------------------------------------------------------------| -| machine_name | none | Windows computer name running the server instance | -| server_name | none | Server and instance information SQL Server associated with Windows instance | -| version | none | Version of the instance，SQL Server，format is "major.minor.build.revision" | -| edition | none | The product SQL server version of the installed instance | -| start_time | none | Database start time | - -#### Metric set：performance_counters - -| Metric name | Metric unit | Metric help description | -|------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| database_pages | none | Database pages, Number of pages obtained (buffer pool) | -| target_pages | none | Target pages, The desired number of pages that the buffer pool must have | -| page_life_expectancy | s | Page life expectancy. The time that data pages stay in the buffer pool. This time is generally greater than 300 | -| buffer_cache_hit_ratio | % | Buffer cache hit ratio, Database buffer pool cache hit rate. The probability that the requested data is found in the buffer pool is generally greater than 80%, otherwise the buffer pool capacity may be too small | -| checkpoint_pages_sec | none | Checkpoint pages/sec, The number of dirty pages written to the disk by the checkpoint per second. If the data is too high, it indicates that there is a lack of memory capacity | -| page_reads_sec | none | Page reads/sec, Number of pages read per second in the cache pool | -| page_writes_sec | none | Page writes/sec, Number of pages written per second in the cache pool | - -#### Metric set：connection - -| Metric name | Metric unit | Metric help description | -|-----------------|-------------|------------------------------| -| user_connection | none | Number of connected sessions | - -### Common Problem - -1. SSL connection problem fixed - -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: -![issue](https://user-images.githubusercontent.com/38679717/206621658-c0741d48-673d-45ff-9a3b-47d113064c12.png) - -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]( 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 deleted file mode 100644 index 253485f8b1a..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/ssl_cert.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: ssl_cert -title: Monitoring SSL Certificate -sidebar_label: SSL Monitor -keywords: [open source monitoring tool, open source ssl cert monitoring tool, monitoring website ssl metrics] ---- - -> Monitor the website's SSL certificate expiration time, response time and other Metrics - -### Configuration parameters - -| Parameter name | Parameter help description | -|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). | -| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. | -| Port | The port provided by the website, https generally defaults to 443. | -| Relative path | The suffix path of the website address except the IP port, for example, `www.tancloud.io/console` The relative path of the website is `/console`. | -| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful | -| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here | - -### Collect metrics - -#### Metric collection: certificate - -| Metric Name | Metric Unit | Metric Help Description | -|-----------------|-----------------|--------------------------| -| subject | none | certificate name | -| expired | no | expired or not | -| start_time | None | Validity start time | -| 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 deleted file mode 100644 index 9f103dfe5be..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/tomcat.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: tomcat -title: Monitor：Apache Tomcat -sidebar_label: Apache Tomcat -keywords: [open source monitoring tool, open source tomcat monitoring tool, monitoring tomcat metrics] ---- - -> Collect and monitor the general performance Metrics of Apache Tomcat. - -**Protocol Use：JMX** - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by JMX | -| Username | JMX connection user name, optional | -| Password | JMX connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metrics - -#### Metrics Set：memory_pool - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| name | | metrics name | -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：code_cache - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| committed | kb | total size | -| init | kb | init size | -| max | kb | max size | -| used | kb | used size | - -#### Metrics Set：class_loading - -| Metric name | Metric unit | Metric help description | -|-----------------------|-------------|--------------------------| -| LoadedClassCount | | Loaded Class Count | -| TotalLoadedClassCount | | Total Loaded Class Count | -| UnloadedClassCount | | Unloaded Class Count | - -#### Metrics Set：thread - -| Metric name | Metric unit | Metric help description | -|-------------------------|-------------|----------------------------| -| TotalStartedThreadCount | | Total Started Thread Count | -| ThreadCount | | Thread Count | -| PeakThreadCount | | Peak Thread Count | -| DaemonThreadCount | | Daemon Thread Count | -| CurrentThreadUserTime | ms | Current Thread User Time | -| CurrentThreadCpuTime | ms | Current Thread Cpu Time | - -### Tomcat Enable JMX Protocol - -1. After building tomcat, enter the bin directory under tomcat and modify the catalina.sh file - -2. vim catalina.sh Attention⚠️ Replace Hostname And Port - -```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 deleted file mode 100644 index 9de28efe095..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/ubuntu.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: ubuntu -title: Monitoring：Ubuntu operating system monitoring -sidebar_label: Ubuntu operating system -keywords: [open source monitoring tool, open source linux ubuntu monitoring tool, monitoring ubuntu metrics] ---- - -> Collect and monitor the general performance Metrics of Ubuntu operating system. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Linux SSH. The default is 22 | -| Username | SSH connection user name, optional | -| Password | SSH connection password, optional | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：basic - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|--------------------------| -| hostname | none | Host name | -| version | none | Operating system version | -| uptime | none | System running time | - -#### Metric set：cpu - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|------------------------------------------------| -| info | none | CPU model | -| cores | cores | Number of CPU cores | -| interrupt | number | Number of CPU interrupts | -| load | none | Average load of CPU in the last 1/5/15 minutes | -| context_switch | number | Number of current context switches | -| usage | % | CPU usage | - -#### Metric set：memory - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------------------| -| total | Mb | Total memory capacity | -| used | Mb | User program memory | -| free | Mb | Free memory capacity | -| buff_cache | Mb | Memory occupied by cache | -| available | Mb | Remaining available memory capacity | -| usage | % | Memory usage | - -#### Metric set：disk - -| Metric name | Metric unit | Metric help description | -|---------------|-------------|----------------------------------------| -| disk_num | blocks | Total number of disks | -| partition_num | partitions | Total number of partitions | -| block_write | blocks | Total number of blocks written to disk | -| block_read | blocks | Number of blocks read from disk | -| write_rate | iops | Rate of writing disk blocks per second | - -#### Metric set：interface - -| Metric name | Metric unit | Metric help description | -|----------------|-------------|------------------------------| -| interface_name | none | Network card name | -| receive_bytes | byte | Inbound data traffic(bytes) | -| transmit_bytes | byte | Outbound data traffic(bytes) | - -#### Metric set：disk_free - -| Metric name | Metric unit | Metric help description | -|-------------|-------------|-------------------------| -| filesystem | none | File system name | -| used | Mb | Used disk size | -| 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 deleted file mode 100644 index 1041755f156..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/website.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: website -title: Monitoring Website -sidebar_label: Website Monitor -keywords: [open source monitoring tool, open source website monitoring tool, monitoring website metrics] ---- - -> Monitor whether the website is available, response time and other Metrics. - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 | -| Relative path | Suffix path of website address except IP port. For example, the relative path of `www.tancloud.io/console` website is `/console` | -| Enable HTTPS | Whether to access the website through HTTPS. Note⚠️When HTTPS is enabled, the default corresponding port needs to be changed to 443 | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：summary - -| 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 deleted file mode 100644 index 99d305cbce5..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/windows.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: windows -title: Monitoring：Windows operating system monitoring -sidebar_label: Windows operating system -keywords: [open source monitoring tool, open source windows monitoring tool, monitoring windows metrics] ---- - -> 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) -[Win configure SNMP in Chinese](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Windows SNMP service. The default is 161 | -| SNMP version | SNMP protocol version V1 V2c V3 | -| SNMP community Word | SNMP agreement community name(Community Name). It is used to realize the authentication of SNMP network administrator when accessing SNMP management agent. Similar to password, the default value is public | -| Timeout | Protocol connection timeout | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：system - -| Metric name | Metric unit | Metric help description | -|--------------|-------------|------------------------------| -| name | none | Host name | -| descr | none | Operating system description | -| uptime | none | System running time | -| numUsers | number | Current number of users | -| 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 deleted file mode 100644 index 362edf8cff9..00000000000 --- a/home/versioned_docs/version-v1.4.x/help/zookeeper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -id: zookeeper -title: Monitoring Zookeeper -sidebar_label: Zookeeper Monitor -keywords: [open source monitoring tool, open source zookeeper monitoring tool, monitoring zookeeper metrics] ---- - -> Collect and monitor the general performance Metrics of Zookeeper. - -### PreRequisites - -#### Zookeeper four word command - -> The current implementation scheme uses the four word command provided by zookeeper to collect Metrics. -> Users need to add the four word command of zookeeper to the white list by themselves. - -Steps - -> 1.Find our zookeeper configuration file, which is usually zoo.cfg. -> -> 2.Add the following commands to the configuration file - -```shell -# Add the required command to the white list -4lw.commands.whitelist=stat, ruok, conf, isro - -# Add all commands to the white list -4lw.commands.whitelist=* -``` - -> 3.Restart service - -```shell -zkServer.sh restart -``` - -#### netcat protocol - -The current implementation scheme requires us to deploy the Linux server of zookeeper -Command environment for installing netcat - -> netcat installation steps -> -> ```shell -> yum install -y nc -> ``` - -If the terminal displays the following information, the installation is successful - -```shell -Complete! -``` - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Monitoring name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Zookeeper. The default is 2181 | -| Query timeout | Set the timeout of Zookeeper connection, unit: ms, default: 3000ms | -| Username | User name of the Linux connection where Zookeeper is located | -| Password | Password of the Linux connection where Zookeeper is located | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：conf - -| Metric name | Metric unit | Metric help description | -|-------------------|-------------|--------------------------------------------------------------------------------------------------------------------| -| clientPort | none | Port | -| dataDir | none | Data snapshot file directory. By default, 100000 operations generate a snapshot | -| dataDirSize | kb | Data snapshot file size | -| dataLogDir | none | Transaction log file directory, production environment on a separate disk | -| dataLogSize | kb | Transaction log file size | -| tickTime | ms | Time interval between servers or between clients and servers to maintain heartbeat | -| minSessionTimeout | ms | Minimum session timeout. Heartbeat timex2. The specified time is less than this time, which is used by default | -| maxSessionTimeout | ms | Maximum session timeout. Heartbeat timex20. The specified time is greater than this time, which is used by default | -| serverId | none | Server id | - -#### Metric set：stats - -| Metric name | Metric unit | Metric help description | -|-------------------------------|-------------|------------------------------------| -| zk_version | none | Server version | -| zk_server_state | none | Server role | -| zk_num_alive_connections | number | Number of connections | -| zk_avg_latency | ms | Average latency | -| zk_outstanding_requests | number | Number of outstanding requests | -| zk_znode_count | number | Number of znode | -| zk_packets_sent | number | Number of packets sent | -| zk_packets_received | number | Number of packets received | -| zk_watch_count | number | Number of watch | -| zk_max_file_descriptor_count | number | Maximum number of file descriptors | -| zk_approximate_data_size | kb | data size | -| zk_open_file_descriptor_count | number | Number of open file descriptors | -| 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 deleted file mode 100644 index f968e1063c9..00000000000 --- a/home/versioned_docs/version-v1.4.x/introduce.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -id: introduce -title: HertzBeat -sidebar_label: Introduce -slug: / ---- - -> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. - -[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr) -[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/) -[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8139/badge)](https://www.bestpractices.dev/projects/8139) -[![Docker Pulls](https://img.shields.io/docker/pulls/apache/hertzbeat?style=%20for-the-badge&logo=docker&label=DockerHub%20Download)](https://hub.docker.com/r/apache/hertzbeat) -[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hertzbeat)](https://artifacthub.io/packages/search?repo=hertzbeat) -[![QQ](https://img.shields.io/badge/QQ-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) -[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) - -**Home: [hertzbeat.apache.org](https://hertzbeat.apache.org) Global | [hertzbeat.com](https://hertzbeat.com) China** - -**Cloud: [console.tancloud.cn](https://console.tancloud.cn)** - -## 🎡 Introduction - -[HertzBeat](https://github.com/apache/hertzbeat) is an easy-to-use, open source, real-time monitoring system with agentless, high performance cluster, prometheus-compatible, offers powerful custom monitoring and status page building capabilities. - -### Features - -* Combines **monitoring, alarm, and notification** features into one platform, and supports monitoring for web service, program, database, cache, os, webserver, middleware, bigdata, cloud-native, network, custom and more. -* Easy to use and agentless, web-based and with one-click monitoring and alerting, zero learning curve. -* Makes protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, allowing you to collect any metrics by simply configuring the template `YML` file online. Imagine being able to quickly adapt to a new monitoring type like K8s or Docker simply by configuring online with HertzBeat. -* Compatible with the `Prometheus` ecosystem and more, can monitoring what `Prometheus` can monitoring with few clicks on webui. -* High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. -* Provides flexible alarm threshold rules and timely notifications delivered via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. -* Provides powerful status page building capabilities, easily communicate the real-time status of your service to users. - -> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system. - ---- - -### Powerful Monitoring Templates - -> Before we discuss the customizable monitoring capabilities of HertzBeat, which we mentioned at the beginning, let's introduce the different monitoring templates of HertzBeat. And it is because of this monitoring template design that the advanced features come later. - -HertzBeat itself did not create a data collection protocol for the monitoring client to adapt to. Instead, HertzBeat makes full use of the existing ecosystem, `SNMP protocol` to collect information from network switches and routers, `JMX specification` to collect information from Java applications, `JDBC specification` to collect information from datasets, `SSH` to directly connect to scripts to get the display information, `HTTP+ (JsonPath | prometheus, etc.)` to parse the information from API interfaces, `IPMI protocol to collect server information, and so on. -HertzBeat uses these existing standard protocols or specifications, makes them abstractly configurable, and finally makes them all available in the form of YML format monitoring templates that can be written to create templates that use these protocols to collect any desired metrics data. -![hertzbeat](/img/blog/multi-protocol.png) - -Do you believe that users can just write a monitoring template on the UI page, click save and immediately adapt a new monitoring type like `K8s` or `Docker`? - -![hertzbeat](/img/home/9.png) - -### Built-in Monitoring Types - -**There are a lot of built-in monitoring templates for users to add directly on the page, one monitoring type corresponds to one YML monitoring template**. - -* [Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), - [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), - [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), - [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), - [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) -* [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), - [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) - [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), - [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) -* [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), - [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), - [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), - [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), - [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) -* [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), - [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), - [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), - [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) -* [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) -* [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), - [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), - [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) -* And More Your Custom Template. -* Notified Support `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. - -### Powerful Customization - -> From the previous introduction of **Monitoring Templates**, it is clear that `HertzBeat` has powerful customization features. -> Each monitor type is considered as a monitor template, no matter it is built-in or user-defined. You can easily add, modify and delete indicators by modifying the monitoring template. -> The templates contain a series of functions such as protocol configuration, environment variables, metrics conversion, metrics calculation, units conversion, metrics collection, etc., which help users to collect the metrics they want. - -![hertzbeat](/img/docs/custom-arch.png) - -### No Agent Required - -> For users who have used various systems, the most troublesome thing is the installation, deployment, debugging and upgrading of various `agents`. -> You need to install one `agent` per host, and several corresponding `agents` to monitor different application middleware, and the number of monitoring can easily reach thousands, so writing a batch script may ease the burden. -> The problem of whether the version of `agent` is compatible with the main application, debugging the communication between `agent` and the main application, upgrading the `agent` synchronization and so on and so forth, are all big headaches. - -The principle of `HertzBeat` is to use different protocols to connect directly to the end system, and use the `PULL` form to pull the collected data, without the need for the user to deploy and install `Agent` | `Exporter` on the host of the end, etc. For example, monitoring the `linux operating system`. - -* For example, if you want to monitor `linux OS`, you can just input the IP port account password or key on `HertzBeat` side. -* For example, to monitor `linux OS`, just enter your ip/port account password or key in `HertzBeat`. - -**Password and other sensitive information is encrypted on all links**. - -### High Performance Clustering - -> When the number of monitors rises exponentially, the collection performance drops or the environment is unstable and prone to single point of failure of the collectors, then our collector clusters come into play. - -* HertzBeat supports the deployment of collector clusters and the horizontal expansion of multiple collector clusters to exponentially increase the number of monitorable tasks and collection performance. -* Monitoring tasks are self-scheduled in the collector cluster, single collector hangs without sensing the failure to migrate the collection tasks, and the newly added collector nodes are automatically scheduled to share the collection pressure. -* It is very easy to switch between stand-alone mode and cluster mode without additional component deployment. - -![hertzbeat](/img/docs/cluster-arch.png) - -### Cloud Edge Collaboration - -> Two locations, three centers, multi-cloud environments, multi-isolated networks, you may have heard of these scenarios. When there is a need for a unified monitoring system to monitor the IT resources of different isolated networks, this is where our Cloud Edge Collaboration comes in. - -In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance. -`HertzBeat` provides the ability of cloud edge collaboration, can be deployed in multiple isolated networks edge collector, collector in the isolated network within the monitoring task collection, collection of data reported by the main service unified scheduling management display. - -![hertzbeat](/img/docs/cluster-arch.png) - -### Easy to Use - -* Set **Monitoring+Alarm+Notification** All in one, no need to deploy multiple component services separately. -* Full UI interface operation, no matter adding new monitor, modifying monitor template, or alarm threshold notification, all can be done in WEB interface, no need to modify files or scripts or reboot. -* No Agent is needed, we only need to fill in the required IP, port, account, password and other parameters in the WEB interface. -* Customization friendly, only need a monitoring template YML, automatically generate monitoring management page, data chart page, threshold configuration for corresponding monitoring types. -* Threshold alarm notification friendly, based on the expression threshold configuration, a variety of alarm notification channels, support alarm silence, time label alarm level filtering and so on. - -### Completely Open Source - -* An open source collaboration product using the `Apache2` protocol, maintained by a free and open source community. -* No monitoring number `License`, monitoring type and other pseudo-open source restrictions . -* Built on `Java+SpringBoot+TypeScript+Angular` mainstream technology stack , convenient secondary development . -* Open source is not the same as free, dev based on HertzBeat must retain 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)** - -![cncf](/img/home/cncf-landscape-left-logo.svg) - ---- - -**HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.** - ------ - -## Quickly Start - -Just run a single command in a Docker environment: `docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` -Browser access `http://localhost:1157` default account password `admin/hertzbeat` - -### Landing Page - -* HertzBeat's user management is unified by the configuration file `sureness.yml`, which allows users to add, delete, and modify user information, user role permissions, and so on. Default password admin/hertzbeat - -![hertzbeat](/img/home/0.png) - -### Overview Page - -* The global overview page shows the distribution of current monitoring categories, users can visualize the current monitoring types and quantities and click to jump to the corresponding monitoring types for maintenance and management. -* Show the status of currently registered collector clusters, including collector on-line status, monitoring tasks, startup time, IP address, name and so on. -* Show the list of recent alarm messages, alarm level distribution and alarm processing rate. - -![hertzbeat](/img/home/1.png) - -### Monitoring Center - -* The monitoring portal supports the management of monitoring of application services, database, operating system, middleware, network, customization, etc. It displays the currently added monitors in the form of a list. -* It displays the currently added monitors in the form of a list and supports adding, modifying, deleting, canceling, importing, exporting and batch management of monitors. -* Support tag grouping, query filtering, view monitoring details portal. - -Built-in support for monitoring types include: - -* [Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), - [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), - [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), - [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), - [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) -* [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), - [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) - [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), - [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) -* [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), - [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), - [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), - [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), - [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) -* [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), - [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), - [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), - [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) -* [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) -* [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), - [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), - [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) - -![hertzbeat](/img/home/2.png) - -### Add and Modify Surveillance - -* You can add or modify monitoring instances of a specific monitoring type, configure the IP, port and other parameters of the monitoring on the other end, set the collection period, collection task scheduling method, support detecting availability in advance, etc. The monitoring instances on the page are defined by the corresponding monitoring templates. -* The monitoring parameters configured on the page are defined by the monitoring template of the corresponding monitoring type, and users can modify the configuration parameters on the page by modifying the monitoring template. -* Support associated tags to manage monitoring grouping, alarm matching, and so on. - -![hertzbeat](/img/home/10.png) - -### Monitor Details - -* The monitoring data detail page shows the basic parameter information of the current monitoring, and the monitoring indicator data information. -* Monitor Real-time Data Report displays the real-time values of all the currently monitored indicators in the form of a list of small cards, and users can configure alarm threshold rules based on the real-time values for reference. -* Monitor Historical Data Report displays the historical values of the currently monitored metrics in the form of trend charts, supports querying hourly, daily and monthly historical data, and supports configuring the page refresh time. -* ⚠️ Note that the monitoring history charts need to be configured with an external timing database in order to get the full functionality, timing database support: IOTDB, TDengine, InfluxDB, GreptimeDB - -![hertzbeat](/img/home/3.png) - -![hertzbeat](/img/home/4.png) - -### Alarm Center - -* The management display page of triggered alarm messages enables users to visualize the current alarm situation. -* Support alarm processing, alarm marking unprocessed, alarm deletion, clearing and other batch operations. - -![hertzbeat](/img/home/7.png) - -### Threshold Rules - -* Threshold rules can be configured for monitoring the availability status, and alerts can be issued when the value of a particular metric exceeds the expected range. -* There are three levels of alerts: notification alerts, critical alerts, and emergency alerts. -* Threshold rules support visual page configuration or expression rule configuration for more flexibility. -* It supports configuring the number of triggers, alarm levels, notification templates, associated with a specific monitor and so on. - -![hertzbeat](/img/home/6.png) - -![hertzbeat](/img/home/11.png) - -### Alarm Convergence - -* When the alarm is triggered by the threshold rule, it will enter into the alarm convergence, the alarm convergence will be based on the rules of the specific time period of the duplicate alarm message de-emphasis convergence, to avoid a large number of repetitive alarms lead to the receiver alarm numbness. -* Alarm convergence rules support duplicate alarm effective time period, label matching and alarm level matching filter. - -![hertzbeat](/img/home/12.png) - -![hertzbeat](/img/home/13.png) - -### Alarm Silence - -* When the alarm is triggered by the threshold rule, it will enter into the alarm silence, the alarm silence will be based on the rules of a specific one-time time period or periodic time period of the alarm message blocking silence, this time period does not send alarm messages. -* This application scenario, such as users in the system maintenance, do not need to send known alarms. Users will only receive alarm messages on weekdays, and users need to avoid disturbances at night. -* Alarm silence rules support one-time time period or periodic time period, support label matching and alarm level matching. - -![hertzbeat](/img/home/14.png) - -![hertzbeat](/img/home/15.png) - -### Message Notification - -* Message notification is a function to notify alarm messages to specified recipients through different media channels, so that the alarm messages can reach them in time. -* It includes recipient information management and notification policy management. Recipient management maintains the information of recipients and their notification methods, while notification policy management maintains the policy rules of which recipients will be notified of the alert messages. -* Notification methods support `Email` `Discord` `Slack` `Telegram` `Pinning` `WeChat` `Flybook` `SMS` `Webhook` and so on. -* The notification policy supports tag matching and alert level matching, which makes it convenient to assign alerts with different tags and alert levels to different receivers and handlers. -* Support notification templates, users can customize the content format of the templates to meet their own personalized notification display needs. - -![hertzbeat](/img/home/16.png) - -![hertzbeat](/img/home/17.png) - -![hertzbeat](/img/home/8.png) - -### Monitoring Templates - -* HertzBeat makes `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` and other protocols configurable so that you can customize the metrics you want to collect using these protocols by simply configuring the monitoring template `YML` in your browser. Would you believe that you can instantly adapt a new monitoring type such as `K8s` or `Docker` just by configuring it? -* All our built-in monitoring types (mysql, website, jvm, k8s) are also mapped to corresponding monitoring templates, so you can add and modify monitoring templates to customize your monitoring functions. - -![hertzbeat](/img/home/9.png) - ------ - -**There's so much more to discover. Have Fun!** - ------ - -**Home: ** -**Github: ** -**Gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/others/contact.md b/home/versioned_docs/version-v1.4.x/others/contact.md deleted file mode 100644 index 9411e50d072..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/contact.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: contact -title: Join discussion -sidebar_label: Discussion ---- - -> If you need any help or want to exchange suggestions during the use process, you can discuss and exchange through ISSUE or Github Discussion. - -[GITHUB ISSUES](https://github.com/apache/hertzbeat/issues) - -[Chat On Discord](https://discord.gg/Fb6M73htGr) - -[Follow Us Twitter](https://twitter.com/hertzbeat1024) - -##### Github Discussion - -Welcome to Discuss in [Github Discussion](https://github.com/apache/hertzbeat/discussions) diff --git a/home/versioned_docs/version-v1.4.x/others/contributing.md b/home/versioned_docs/version-v1.4.x/others/contributing.md deleted file mode 100644 index 7c0c80721f3..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/contributing.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -id: contributing -title: Contributing Guide -sidebar_label: Contributing Guide ---- - -> We are committed to maintaining a happy community that helps each other, welcome every contributor to join us! - -### Kinds of Contributions - -> In the HertzBeat community, there are many ways to contribute: - -- 💻**Code**: Can help the community complete some tasks, write new features or fix some bugs; - -- ⚠️**Test**: Can come to participate in the writing of test code, including unit testing, integration testing, e2e testing; - -- 📖**Docs**: Can write or Documentation improved to help users better understand and use HertzBeat; - -- 📝**Blog**: You can write articles about HertzBeat to help the community better promote; - -- 🤔**Discussion**: You can participate in the discussion of new features of HertzBeat and integrate your ideas with HertzBeat; - -- 💡**Preach**: Can help publicize or promote the HertzBeat community, speak in meetup or summit; - -- 💬**Suggestion**: You can also make some suggestions to the project or community to promote the healthy development of the community; - -More see [Contribution Types](https://allcontributors.org/docs/en/emoji-key) - -Even small corrections to typos are very welcome :) - -### Getting HertzBeat up and running - -> To get HertzBeat code running on your development tools, and able to debug with breakpoints. -> This is a front-end and back-end separation project. To start the local code, the back-end [manager](https://github.com/apache/hertzbeat/tree/master/manager) and the front-end [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) must be started separately. - -- Backend start - -1. Requires `maven3+`, `java11` and `lombok` environments -2. (Optional) Modify the configuration file-`manager/src/main/resources/application.yml` -3. Start `springboot manager` service `manager/src/main/java/org/apache/hertzbeat/manager/Manager.java` - -- Front-web start - -1. Need `nodejs npm angular-cli` environment -2. Install yarn: `npm install -g yarn` -3. Execute under the front-end project directory web-app: `yarn install` -4. Install angular-cli globally: `npm install -g @angular/cli@14 --registry=https://registry.npm.taobao.org` -5. After the local backend is started, start the local frontend in the web-app directory: `ng serve --open` -6. Browser access to localhost:4200 to start, default account/password is *admin/hertzbeat* - -### Find tasks - -Find the issue you are interested in! On our GitHub repo issue list, we often publish some issues with the label good first issue or status: volunteer wanted. -These issues welcome the help of contributors. Among them, good first issues tend to have low thresholds and are suitable for novices. - -Of course, if you have a good idea, you can also propose it directly on GitHub Discussion or contact with community. - -### Submit Pull Request - -1. First you need to fork your target [hertzbeat repository](https://github.com/apache/hertzbeat). -2. Then download the code locally with git command: - -```shell -git clone git@github.com:${YOUR_USERNAME}/hertzbeat.git #Recommended -``` - -3. After the download is complete, please refer to the getting started guide or README file of the target repository to initialize the project. -4. Then, you can refer to the following command to submit the code: - -```shell -git checkout -b a-feature-branch #Recommended -``` - -5. Submit the coed as a commit, the commit message format specification required: [module name or type name] feature or bugfix or doc: custom message. - -```shell -git add -git commit -m '[docs]feature: necessary instructions' #Recommended -``` - -6. Push to the remote repository - -```shell -git push origin a-feature-branch -``` - -7. Then you can initiate a new PR (Pull Request) on GitHub. - -Please note that the title of the PR needs to conform to our spec, and write the necessary description in the PR to facilitate code review by Committers and other contributors. - -### Wait for the code to be merged - -After submitting the PR, the Committee or the community's friends will review the code you submitted (Code Review), and will propose some modification suggestions or conduct some discussions. Please pay attention to your PR in time. - -If subsequent changes are required, there is no need to initiate a new PR. After submitting a commit on the original branch and pushing it to the remote repository, the PR will be automatically updated. - -In addition, our project has a relatively standardized and strict CI inspection process. After submitting PR, CI will be triggered. Please pay attention to whether it passes the CI inspection. - -Finally, the Committers can merge the PR into the master branch. - -### After the code is merged - -After the code has been merged, you can delete the development branch on both the local and remote repositories: - -```shell -git branch -d a-dev-branch -git push origin --delete a-dev-branch -``` - -On the master/main branch, you can do the following to sync the upstream repository: - -```shell -git remote add upstream https://github.com/apache/hertzbeat.git #Bind the remote warehouse, if it has been executed, it does not need to be executed again -git checkout master -git pull upstream master -``` - -### How to become a Committer? - -With the above steps, you are a contributor to HertzBeat. Repeat the previous steps to stay active in the community, keep at, you can become a Committer! - -### Join Discussion - -[Github Discussion](https://github.com/apache/hertzbeat/discussions) - -Add WeChat account `ahertzbeat` to pull you into the WeChat group. - -QQ group number `630061200`, verify code: `tancloud` - -Public WeChat: `tancloudtech` - -## 🥐 Architecture - -- **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services. - -> Provides monitoring management, monitoring configuration management, system user management, etc. -> -> - **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** Provide metrics data collection services. -> Use common protocols to remotely collect and obtain peer-to-peer metrics data. -> - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. -> Metrics data management, data query, calculation and statistics. -> - **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** Provide alert service. -> Alarm calculation trigger, monitoring status linkage, alarm configuration, and alarm notification. -> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** Provide web ui. -> Angular Web UI. - -![hertzBeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat/home/static/img/docs/hertzbeat-arch.svg) diff --git a/home/versioned_docs/version-v1.4.x/others/design.md b/home/versioned_docs/version-v1.4.x/others/design.md deleted file mode 100644 index 64e248f5b2d..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/design.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: design -title: Design Document -sidebar_label: Design Document ---- - -### HertzBeat Architecture - -![architecture](https://cdn.jsdelivr.net/gh/apache/hertzbeat/home/static/img/docs/hertzbeat-arch.svg) - -### TanCloud Architecture - -TanCloud is a SAAS cluster version based on HertzBeat, which adopts a multi-cluster and multi-tenant architecture model. diff --git a/home/versioned_docs/version-v1.4.x/others/developer.md b/home/versioned_docs/version-v1.4.x/others/developer.md deleted file mode 100644 index bdaf8172b8b..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/developer.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -id: developer -title: Contributors -sidebar_label: Contributors ---- - -## ✨ HertzBeat Members - - - - - - - - - - - - - - - - - - - -
tomsun28
tomsun28
💻 📖 🎨		会编程的王学长
会编程的王学长
💻 📖 🎨		zcx
zcx
💻 🐛 🎨		进击的阿晨
进击的阿晨
💻 🎨 🐛		铁甲小宝
铁甲小宝
🐛 💻 📖		cuipiheqiuqiu
cuipiheqiuqiu
💻 ⚠️ 🎨		hudongdong129
hudongdong129
💻 ⚠️ 📖
zqr10159
Logic
📖 💻🎨		vinci
vinci
💻 📖 🎨		淞筱
淞筱
💻 📖 🎨		东风
东风
💻 🎨 📖
- -cert - -## ✨ HertzBeat Contributors - -Thanks to these wonderful people, welcome to join us: [Contributor Guide](contributing) - -cert - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tomsun28
tomsun28
💻 📖 🎨		会编程的王学长
会编程的王学长
💻 📖 🎨		MaxKey
MaxKey
💻 🎨 🤔		观沧海
观沧海
💻 🎨 🐛		yuye
yuye
💻 📖		jx10086
jx10086
💻 🐛		winnerTimer
winnerTimer
💻 🐛
goo-kits
goo-kits
💻 🐛		brave4Time
brave4Time
💻 🐛		WalkerLee
WalkerLee
💻 🐛		jianghang
jianghang
💻 🐛		ChineseTony
ChineseTony
💻 🐛		wyt199905
wyt199905
💻		卫傅庆
卫傅庆
💻 🐛
zklmcookle
zklmcookle
💻		DevilX5
DevilX5
📖 💻		tea
tea
💻		yangshihui
yangshihui
💻 🐛		DreamGirl524
DreamGirl524
💻 📖		gzwlly
gzwlly
📖		cuipiheqiuqiu
cuipiheqiuqiu
💻 ⚠️ 🎨
lambert
lambert
💻		mroldx
mroldx
📖		woshiniusange
woshiniusange
📖		VampireAchao
VampireAchao
💻		zcx
zcx
💻 🐛 🎨		CharlieXCL
CharlieXCL
📖		Privauto
Privauto
💻 📖
emrys
emrys
📖		SxLiuYu
SxLiuYu
🐛		All Contributors
All Contributors
📖		铁甲小宝
铁甲小宝
💻 📖		click33
click33
📖		蒋小小
蒋小小
📖		Kevin Huang
Kevin Huang
📖
铁甲小宝
铁甲小宝
🐛 💻 📖		Captain Jack
Captain Jack
📖		haibo.duan
haibo.duan
⚠️ 💻		assassin
assassin
🐛 💻		Reverse wind
Reverse wind
⚠️ 💻		luxx
luxx
💻		Ikko Ashimine
Ikko Ashimine
📖
leizenan
leizenan
💻		BKing
BKing
📖		xingshuaiLi
xingshuaiLi
📖		wangke6666
wangke6666
📖		刺猬
刺猬
🐛 💻		Haste
Haste
💻		zhongshi.yi
zhongshi.yi
📖
Qi Zhang
Qi Zhang
📖		MrAndyMing
MrAndyMing
📖		idongliming
idongliming
💻		Zichao Lin
Zichao Lin
💻 📖		liudonghua
liudonghua
💻 🤔		Jerry
Jerry
💻 ⚠️ 🤔		yanhom
yanhom
📖
fsl
fsl
💻		xttttv
xttttv
📖		NavinKumarBarnwal
NavinKumarBarnwal
💻		Zakkary
Zakkary
📖		sunxinbo
sunxinbo
💻 ⚠️		ldzbook
ldzbook
📖 🐛		余与雨
余与雨
💻 ⚠️
MysticalDream
MysticalDream
💻 ⚠️		zhouyoulin12
zhouyoulin12
💻 ⚠️		jerjjj
jerjjj
💻		wjl110
wjl110
💻		Sean
Sean
📖		chenyiqin
chenyiqin
💻 ⚠️		hudongdong129
hudongdong129
💻 ⚠️ 📖
TherChenYang
TherChenYang
💻 ⚠️		HattoriHenzo
HattoriHenzo
💻 ⚠️		ycilry
ycilry
📖		aoshiguchen
aoshiguchen
📖 💻		蔡本祥
蔡本祥
💻		浮游
浮游
💻		Grass-Life
Grass-Life
💻
xiaohe428
xiaohe428
💻 📖		TableRow
TableRow
📖 💻		ByteIDance
ByteIDance
💻		Jangfe
Jangfe
💻		zqr10159
zqr10159
📖 💻		vinci
vinci
💻 📖 🎨		js110
js110
💻
CrazyLionLi
CrazyLionLi
📖		banmajio
banmajio
💻		topsuder
topsuder
💻		richar2022
richar2022
💻		fcb-xiaobo
fcb-xiaobo
💻		wenkyzhang
wenkyzhang
📖		ZangJuxy
ZangJuxy
📖
l646505418
l646505418
💻		Carpe-Wang
Carpe-Wang
💻		莫枢
莫枢
💻		huangcanda
huangcanda
💻		世纪末的架构师
世纪末的架构师
💻		ShuningWan
ShuningWan
📖		MrYZhou
MrYZhou
📖
suncqujsj
suncqujsj
📖		sunqinbo
sunqinbo
💻		haoww
haoww
📖		i-mayuan
i-mayuan
📖		fengruge
fengruge
📖		zhanghuan
zhanghuan
💻		shenymin
shenymin
💻
Dhruva Chandra
Dhruva Chandra
💻		miss_z
miss_z
📖		wyt990
wyt990
💻		licocon
licocon
💻		Mi Na
Mi Na
💻		Kylin-Guo
Kylin-Guo
📖		Mr灬Dong先生
Mr灬Dong先生
💻
Pratyay Banerjee
Pratyay Banerjee
📖 💻		yujianzhong520
yujianzhong520
💻		SPPan
SPPan
💻		ZhangJiashu
ZhangJiashu
💻		impress
impress
💻		凌晨一点半
凌晨一点半
📖		Eeshaan Sawant
Eeshaan Sawant
💻
nandofromthebando
nandofromthebando
💻		caiboking
caiboking
💻		baixing99
baixing99
💻		Yang Chuang
Yang Chuang
💻		wlin20
wlin20
💻		guojing1983
guojing1983
💻		moxi
moxi
📖
qq471754603
qq471754603
💻		渭雨
渭雨
💻		liuxuezhuo
liuxuezhuo
💻		lisongning
lisongning
💻		YutingNie
YutingNie
💻 📖 🎨		Mike Zhou
Mike Zhou
💻 📖 🎨		小笨蛋
小笨蛋
💻
littlezhongzer
littlezhongzer
💻		ChenXiangxxxxx
ChenXiangxxxxx
💻		Mr.zhou
Mr.zhou
💻		姚贤丰
姚贤丰
💻		lingluojun
lingluojun
💻		1ue
1ue
💻		qyaaaa
qyaaaa
💻
novohit
novohit
💻		zhuoshangyi
zhuoshangyi
💻		ruanliang
ruanliang
📖 💻		Eden4701
Eden4701
💻 📖 🎨		XiaTian688
XiaTian688
📖		liyinjiang
liyinjiang
💻		ZhangJiashu
ZhangJiashu
📖
moghn
moghn
📖		xiaoguolong
xiaoguolong
💻		Smliexx
Smliexx
💻		Naruse
Naruse
📖 💻		Bala Sukesh
Bala Sukesh
💻		Jinyao Ma
Jinyao Ma
💻		Rick
Rick
💻 ⚠️
东风
东风
💻 🎨 📖		sonam singh
sonam singh
💻		ZhangZixuan1994
ZhangZixuan1994
💻		SHIG
SHIG
💻		泰上老菌
泰上老菌
💻		ldysdu
ldysdu
💻		梁同学
梁同学
💻
avv
avv
💻		yqxxgh
yqxxgh
📖		CharlieShi46
CharlieShi46
💻		Nctllnty
Nctllnty
💻		Wang-Yonghao
Wang-Yonghao
📖
- - - - diff --git a/home/versioned_docs/version-v1.4.x/others/hertzbeat.md b/home/versioned_docs/version-v1.4.x/others/hertzbeat.md deleted file mode 100644 index d06ffeb7fde..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/hertzbeat.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -id: hertzbeat -title: HertzBeat 开源实时监控系统 -sidebar_label: HertzBeat 实时监控 ---- - -> 易用友好的开源实时监控告警系统，无需Agent，高性能集群，强大自定义监控能力。 - -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/web-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/ping-connect.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/port-available.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/database-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/os-monitor.svg) -![hertzbeat](https://img.shields.io/badge/monitor-cloud%20native-brightgreen) -![hertzbeat](https://img.shields.io/badge/monitor-middleware-blueviolet) -![hertzbeat](https://img.shields.io/badge/monitor-network-red) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/alert.svg) - -## 🎡 介绍 - -[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，高性能集群，无需 Agent 的开源实时监控告警系统。 - -### 特点 - -- 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控阈值告警通知一步到位。 -- 易用友好，无需 `Agent`，全 `WEB` 页面操作，鼠标点一点就能监控告警，零上手学习成本。 -- 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ -- 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 -- 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式消息及时送达。 - -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 - ----- - -### 完全开源 - -- 使用`Apache2`协议，由自由开放的开源社区主导维护的开源协作产品。 -- 无监控数量`License`，监控类型等伪开源限制。 -- 基于`Java+SpringBoot+TypeScript+Angular`主流技术栈构建，方便的二次开发。 -- 但开源不等同于免费，基于HertzBeat二次开发需保留logo，名称，页面脚注，版权等。 - -### 强大的监控模版 - -> 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 - -HertzBeat 自身并没有去创造一种采集数据协议，让对端来适配它。而是充分使用了现有的生态，SNMP采集网络交换机路由器信息，JMX采集JAVA应用信息，JDBC规范采集数据集信息，SSH直连执行脚本获取回显信息，HTTP+(JsonPath | prometheus等)解析接口信息，IPMI采集服务器信息等等。 -HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标信息。 - -![hertzbeat](/img/blog/multi-protocol.png) - -你相信用户只需在UI页面编写一个监控模版，点击保存后，就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ - -![hertzbeat](/img/home/9.png) - -### 内置监控类型 - -**一款监控类型对应一个YML监控模版** - -- [Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml) -- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), - [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) -- [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) -- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml) -- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) -- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), - [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), - [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) -- 和更多自定义监控模版。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 - -### 强大自定义功能 - -> 由前面的**监控模版**介绍，大概清楚了 HertzBeat 拥有的强大自定义功能。 -> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 -> 模版里面包含各个协议的使用，指标别名转换，指标计算，单位转换等一系列功能，帮助用户能采集到自己想要的监控指标。 - -![hertzbeat](/img/docs/custom-arch.png) - -### 无需 Agent - -> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 agent 的安装部署调试了。 -> 每台主机得装个 agent，为了监控不同应用中间件可能还得装几个对应的 agent，量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 -> agent 的版本是否与主应用兼容, agent 与主应用的通讯调试, agent 的同步升级等等等等，这些全是头大的点。 - -HertzBeat 的原理就是使用不同的协议去直连对端系统，采集 PULL 的形式去拉取采集数据，无需用户在对端主机上部署安装 Agent | Exporter等。 -比如监控 linux, 在 HertzBeat 端输入IP端口账户密码或密钥即可。 -比如监控 mysql, 在 HertzBeat 端输入IP端口账户密码即可。 -**密码等敏感信息全链路加密** - -### 高性能集群 - -> 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -> 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 -> 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 - -![hertzbeat](/img/docs/cluster-arch.png) - -### 云边协同 - -> 支持部署边缘采集器集群，与主 HertzBeat 服务云边协同提升采集能力。 - -在多个网络不相通的隔离网络中，在以往的方案中我们需要在每个网络都部署一套监控系统，这导致数据不互通，管理部署维护都不方便。 -HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主 HertzBeat 服务统一调度管理展示。 - -![hertzbeat](/img/docs/cluster-arch.png) - -### 易用友好 - -> 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 -> 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 -> 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 -> 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 -> 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 - ---- -**`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** - ------ - -## 即刻体验一波 - -Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` -浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` - -### 登陆页面 - -- HertzBeat 的用户管理统一由配置文件 `sureness.yml` 维护，用户可以通过修改此文件来新增删除修改用户信息，用户角色权限等。默认账户密码 admin/hertzbeat - -![hertzbeat](/img/home/0.png) - -### 概览页面 - -- 全局概览页面，分类展示了当前监控大类别数量分布，用户可直观查看当前的监控类型与数量并点击跳转至对应监控类型进行维护管理。 -- 展示当前注册的采集器集群状态，包括采集器的上线状态，监控任务，启动时间，IP地址，名称等。 -- 下发展示了最近告警信息列表，告警级别分布情况，告警处理率情况。 - -![hertzbeat](/img/home/1.png) - -### 监控中心 - -- 监控入口，支持对应用服务，数据库，操作系统，中间件，网络，自定义等监控的管理。 -- 以列表的形式展示当前已添加的监控，支持对监控的新增，修改，删除，取消监控，导入导出，批量管理等。 -- 支持标签分组，查询过滤，查看监控详情入口等。 - -内置支持的监控类型包括： - -- [Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml) -- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), - [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) -- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), - [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), - [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), - [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), - [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) -- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml) -- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) -- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), - [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), - [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) - -![hertzbeat](/img/home/2.png) - -### 新增修改监控 - -- 新增或修改指定监控类型的监控实例，配置对端监控的IP，端口等参数，设置采集周期，采集任务调度方式，支持提前探测可用性等。 -- 页面上配置的监控参数由对应监控类型的监控模版所定义，用户可以通过修改监控模版来修改页面配置参数。 -- 支持关联标签，用标签来管理监控分组，告警匹配等。 - -![hertzbeat](/img/home/10.png) - -### 监控详情 - -- 监控的数据详情页面，展示了当前监控的基本参数信息，监控指标数据信息。 -- 监控实时数据报告，以小卡片列表的形式展示了当前监控的所有指标实时值，用户可根据实时值参考配置告警阈值规则。 -- 监控历史数据报告，以趋势图表的形式展示了当前监控数值类型的指标的历史值，支持查询小时，天，月的历史数据，支持配置页面刷新时间。 -- ⚠️注意监控历史图表需配置外置时序数据库才能获取完整功能，时序数据库支持: IOTDB, TDengine, InfluxDB, GreptimeDB - -![hertzbeat](/img/home/3.png) - -![hertzbeat](/img/home/4.png) - -### 告警中心 - -- 已触发告警消息的管理展示页面，使用户有直观的展示当前告警情况。 -- 支持告警处理，告警标记未处理，告警删除清空等批量操作。 - -![hertzbeat](/img/home/7.png) - -### 阈值规则 - -- 对于监控的可用性状态设置阈值规则，特定指标的值超过我们预期范围时发出告警，这些都可以在阈值规则这里配置。 -- 告警级别分为三级：通知告警，严重告警，紧急告警。 -- 阈值规则支持可视化页面配置或表达式规则配置，灵活性更高。 -- 支持配置触发次数，告警级别，通知模版，关联指定监控等。 - -![hertzbeat](/img/home/6.png) - -![hertzbeat](/img/home/11.png) - -### 告警收敛 - -- 当通过阈值规则判断触发告警后，会进入到告警收敛，告警收敛会根据规则对特定时间段的重复告警消息去重收敛，已避免大量重复性告警导致接收人告警麻木。 -- 告警收敛规则支持重复告警生效时间段，标签匹配和告警级别匹配过滤。 - -![hertzbeat](/img/home/12.png) - -![hertzbeat](/img/home/13.png) - -### 告警静默 - -- 当通过阈值规则判断触发告警后，会进入到告警静默，告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默，此时间段不发送告警消息。 -- 此应用场景如用户在系统维护中，无需发已知告警。用户在工作日时间才会接收告警消息，用户在晚上需避免打扰等。 -- 告警静默规则支持一次性时间段或周期性时间段，支持标签匹配和告警级别匹配。 - -![hertzbeat](/img/home/14.png) - -![hertzbeat](/img/home/15.png) - -### 消息通知 - -- 消息通知功能是把告警消息通过不同媒体渠道通知给指定的接收人，告警消息及时触达。 -- 功能包含接收人信息管理和通知策略管理，接收人管理维护接收人信息以其通知方式信息，通知策略管理维护把哪些告警信息通知给哪些接收人的策略规则。 -- 通知方式支持 `邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式。 -- 通知策略支持标签匹配和告警级别匹配，方便的使不同标签的告警和告警级别分派给不同的接收处理人。 - -![hertzbeat](/img/home/16.png) - -![hertzbeat](/img/home/17.png) - -![hertzbeat](/img/home/8.png) - -### 监控模版 - -- HertzBeat 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ -- 同理我们内置的所有监控类型(mysql,website,jvm,k8s)也一一映射为对应的监控模版，用户可以新增修改监控模版来自定义监控功能。 - -![hertzbeat](/img/home/9.png) - ---- - -**`HertzBeat`更多强大的功能欢迎使用探索。Have Fun!** - ------ - -**官网: ** -**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 deleted file mode 100644 index bc2c4f50c96..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/huaweicloud.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: huaweicloud -title: HertzBeat & HuaweiCloud -sidebar_label: HertzBeat & HuaweiCloud ---- - -### HertzBeat 与 HuaweiCloud 的开源合作需求Issue - -> 欢迎大家对感兴趣的Issue领取贡献。 - -- [Task] support using Huawei Cloud OBS to store custom define yml file [#841](https://github.com/apache/hertzbeat/issues/841) -- [Task] support Huawei Cloud CCE metrics monitoring [#839](https://github.com/apache/hertzbeat/issues/839) -- [Task] support EulerOS metrics monitoring [#838](https://github.com/apache/hertzbeat/issues/838) -- [Task] support using Huawei Cloud SMN send alarm notification message [#837](https://github.com/apache/hertzbeat/issues/837) -- [Task] support using GaussDB For Influx store history metrics data [#836](https://github.com/apache/hertzbeat/issues/836) - -### 关于 HuaweiCloud 开源活动 - -HuaweiCloud 华为云将面向开源软件工具链与环境、开源应用构建和开源生态组件构建这三大重点场景，提供技术支持、奖金支持、活动支持，邀请更多的开发者，携手构建开源for HuaweiCloud。 - -开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 - -感兴趣的开发者可以查看：华为云开源项目仓库 了解更多。 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 deleted file mode 100644 index 3cdc25e6196..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/images-deploy.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -id: images-deploy -title: HertzBeat 华为云镜像部署 -sidebar_label: HertzBeat 华为云镜像部署快速指引 ---- - -> 易用友好的开源实时监控告警工具，无需Agent，强大自定义监控能力。 - -[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr) -[![QQ](https://img.shields.io/badge/qq-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/web-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/ping-connect.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/port-available.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/database-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/os-monitor.svg) -![hertzbeat](https://img.shields.io/badge/monitor-cloud%20native-brightgreen) -![hertzbeat](https://img.shields.io/badge/monitor-middleware-blueviolet) -![hertzbeat](https://img.shields.io/badge/monitor-network-red) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/custom-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/alert.svg) - -## 🎡 介绍 - -> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警通知一步到位。 -> 更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 -> -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 -> 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ -> -> `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -> 当然我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**，中小团队和个人无需再为了监控自己的网站资源，而去部署学习一套繁琐的监控系统，**[登录即可免费开始](https://console.tancloud.cn)**。 - ----- - -![hertzbeat](/img/home/1.png) - -![hertzbeat](/img/home/9.png) - -## ⛄ Supported - -- [网站监控](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-website.yml), [端口可用性](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-api.yml), [Ping连通性](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap全站](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl证书](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP服务器](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ftp.yml) -- [Mysql](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mongodb.yml), - [达梦](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-iotdb.yml) -- [Linux](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-windows.yml) -- [Tomcat](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-activemq.yml) -- [Kubernetes](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-docker.yml) -- 和更多的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 - -## 镜像部署 - -> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 - -1. 开通服务器时选用 HertzBeat 镜像 -2. 启动服务器 -3. 配置HertzBeat的配置文件(可选) - - 修改位于 `/opt/hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件 - - 若需使用邮件发送告警，需替换`application.yml`里面的邮件服务器参数 - - **推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](../start/mysql-change)） - - **推荐**若需使用时序数据库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` 的配置文件实现，若无此需求可忽略此步骤 - 具体参考 [配置修改账户密码](../start/account-modify) - -5. 部署启动 - 执行位于安装目录/opt/hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - - ``` - ./startup.sh - ``` - -6. 开始探索HertzBeat - 浏览器访问 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 - -**HAVE FUN** - -### 部署常见问题 - -**最多的问题就是网络问题，请先提前排查** - -1. **按照流程部署，访问 无界面** - 请参考下面几点排查问题： - -> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 -> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 - -2. **监控历史图表长时间都一直无数据** - -> 一：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 deleted file mode 100644 index 6b52c0ee20d..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/resource.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: resource -title: Related resources -sidebar_label: Related resources ---- - -## HertzBeat Introduce PDF - -Download: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf) - -## Icon Resources - -### HertzBeat Logo - -![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 deleted file mode 100644 index c741e29218a..00000000000 --- a/home/versioned_docs/version-v1.4.x/others/sponsor.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: sponsor -title: Sponsor -sidebar_label: Sponsor ---- - -**Hertzbeat is completely free for individuals or enterprises. If you like this project and are willing to help, buy us a cup of coffee** - -![wechat-alipay](/img/docs/pay.png) - -Thanks [JiShi Information(build a new microwave + optical transaction network)](https://www.flarespeed.com) sponsored server node. -Thanks [TianShang cloud computing(new wisdom cloud)](https://www.tsyvps.com/aff/BZBEGYLX) sponsored server node. 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 deleted file mode 100644 index 99541502eb2..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/account-modify.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -id: account-modify -title: Modify Account Username Password -sidebar_label: Update Account ---- - -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) -Modify the following **part parameters** in sureness.yml：**[Note⚠️Other default sureness configuration parameters should be retained]** - -```yaml - -resourceRole: - - /api/account/auth/refresh===post===[admin,user,guest] - - /api/apps/**===get===[admin,user,guest] - - /api/monitor/**===get===[admin,user,guest] - - /api/monitor/**===post===[admin,user] - - /api/monitor/**===put===[admin,user] - - /api/monitor/**===delete==[admin] - - /api/monitors/**===get===[admin,user,guest] - - /api/monitors/**===post===[admin,user] - - /api/monitors/**===put===[admin,user] - - /api/monitors/**===delete===[admin] - - /api/alert/**===get===[admin,user,guest] - - /api/alert/**===post===[admin,user] - - /api/alert/**===put===[admin,user] - - /api/alert/**===delete===[admin] - - /api/alerts/**===get===[admin,user,guest] - - /api/alerts/**===post===[admin,user] - - /api/alerts/**===put===[admin,user] - - /api/alerts/**===delete===[admin] - - /api/notice/**===get===[admin,user,guest] - - /api/notice/**===post===[admin,user] - - /api/notice/**===put===[admin,user] - - /api/notice/**===delete===[admin] - - /api/tag/**===get===[admin,user,guest] - - /api/tag/**===post===[admin,user] - - /api/tag/**===put===[admin,user] - - /api/tag/**===delete===[admin] - - /api/summary/**===get===[admin,user,guest] - - /api/summary/**===post===[admin,user] - - /api/summary/**===put===[admin,user] - - /api/summary/**===delete===[admin] - -# Resources that need to be filtered and protected can be accessed directly without authentication -# /api/v1/source3===get means /api/v1/source3===get it can be accessed by anyone. Don't need to authentication -excludedResource: - - /api/account/auth/**===* - - /api/i18n/**===get - - /api/apps/hierarchy===get - # web ui the front-end static resource - - /===get - - /dashboard/**===get - - /monitors/**===get - - /alert/**===get - - /account/**===get - - /setting/**===get - - /passport/**===get - - /**/*.html===get - - /**/*.js===get - - /**/*.css===get - - /**/*.ico===get - - /**/*.ttf===get - - /**/*.png===get - - /**/*.gif===get - - /**/*.jpg===get - - /**/*.svg===get - - /**/*.json===get - # swagger ui resource - - /swagger-resources/**===get - - /v2/api-docs===get - - /v3/api-docs===get - -# user account information -# Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest],text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] -``` - -Modify the following **part parameters** in sureness.yml **[Note⚠️Other default sureness configuration parameters should be retained]**： - -```yaml - -# user account information -# Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest], text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] -``` - -## Update Security Secret - -> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. - -Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. - -```yaml -sureness: - jwt: - secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx3sDJeFV643R - LnfKefTjsIfJLBa2YkhEqEGtcHDTNe4CU6+9 - 8tVt4bisXQ13rbN0oxhUZR73M6EByXIO+SV5 - dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' -``` - -**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 deleted file mode 100644 index 7f45b5dd27d..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/custom-config.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: custom-config -title: Advanced Params Config -sidebar_label: Advanced Params Config ---- - -This describes how to configure the SMS server, the number of built-in availability alarm triggers, etc. - -**Configuration file `application.yml` of `hertzbeat`** - -### 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 -The installation package can be decompressed and modified in `hertzbeat/config/application.yml` - -1. Configure the SMS sending server - -> Only when your own SMS server is successfully configured, the alarm SMS triggered in the monitoring tool will be sent normally. - -Add the following Tencent platform SMS server configuration in `application.yml` (parameters need to be replaced with your SMS server configuration) - -```yaml -common: - sms: - tencent: - secret-id: AKIDbQ4VhdMr89wDedFrIcgU2PaaMvOuBCzY - secret-key: PaXGl0ziY9UcWFjUyiFlCPMr77rLkJYlyA - app-id: 1435441637 - sign-name: XX Technology - template-id: 1343434 -``` - -2. Configure alarm custom parameters - -```yaml -alerter: - # Custom console address - console-url: https://console.tancloud.io -``` - -3. Use external redis instead of memory to store real-time metric data - -> By default, the real-time data of our metrics is stored in memory, which can be configured as follows to use redis instead of memory storage. - -Note ⚠️ `memory.enabled: false, redis.enabled: true` - -```yaml -warehouse: - store: - memory: - enabled: false - init-size: 1024 - redis: - enabled: true - host: 127.0.0.1 - 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 deleted file mode 100644 index a1ff268fcb0..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/docker-deploy.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: docker-deploy -title: Install HertzBeat via Docker -sidebar_label: Install via Docker ---- - -> Recommend to use docker deploy HertzBeat - -1. Download and install the Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 - After the installation you can check if the Docker version normally output at the terminal. - - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -2. pull HertzBeat Docker mirror - you can look up the mirror version TAG in [dockerhub mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) - or in [quay.io mirror repository](https://quay.io/repository/apache/hertzbeat) - - ```shell - docker pull apache/hertzbeat - docker pull apache/hertzbeat-collector - ``` - - or - - ```shell - docker pull quay.io/tancloud/hertzbeat - docker pull quay.io/tancloud/hertzbeat-collector - ``` - -3. Mounted HertzBeat configuration file (optional) - Download and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` - Download from [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) 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) - For detail steps, please refer to [Configure Account Password](account-modify) -5. Start the HertzBeat Docker container - -```shell -$ docker run -d -p 1157:1157 -p 1158:1158 \ - -e LANG=en_US.UTF-8 \ - -e TZ=Asia/Shanghai \ - -v $(pwd)/data:/opt/hertzbeat/data \ - -v $(pwd)/logs:/opt/hertzbeat/logs \ - -v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \ - -v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml \ - --name hertzbeat apache/hertzbeat -``` - -This command starts a running HertzBeat Docker container with mapping port 1157-1158. If existing processes on the host use the port, please modify host mapped port. - -- `docker run -d` : Run a container in the background via Docker -- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port. -- `-e LANG=en_US.UTF-8` : Set the system language -- `-e TZ=Asia/Shanghai` : Set the system timezone -- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important⚠️ Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container. -- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional, if you don't have a need, just delete it) Mount the log file to the local host, to ensure the log will not be lost due creating or deleting container. -- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional, if you don't have a need, just delete it) Mount the local configuration file into the container which has been modified in the previous step, namely using the local configuration file to cover container configuration file. -- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional, if you don't have a need, just delete it) Mount account configuration file modified in the previous step into the container. Delete this command parameters if no needs. -- `--name hertzbeat` : Naming container name hertzbeat -- `apache/hertzbeat` : Use the pulled latest HertzBeat official application mirror to start the container. **Use `quay.io/tancloud/hertzbeat` instead if you pull `quay.io` docker image.** - -6. Begin to explore HertzBeat - - Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! - -7. Deploy collector cluster (Optional) - -```shell -$ docker run -d \ - -e IDENTITY=custom-collector-name \ - -e MODE=public \ - -e MANAGER_HOST=127.0.0.1 \ - -e MANAGER_PORT=1158 \ - --name hertzbeat-collector apache/hertzbeat-collector -``` - -This command starts a running HertzBeat-Collector container. - -- `docker run -d` : Run a container in the background via Docker -- `-e IDENTITY=custom-collector-name` : (optional) Set the collector unique identity name. Attention the clusters collector name must unique. -- `-e MODE=public` : set the running mode(public or private), public cluster or private cloud-edge. -- `-e MANAGER_HOST=127.0.0.1` : Important⚠️ Set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : (optional) Set the main hertzbeat server port, default 1158. -- `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (optional) Mount the log file to the local host, to ensure the log will not be lost due creating or deleting container. -- `--name hertzbeat-collector` : Naming container name hertzbeat-collector -- `apache/hertzbeat-collector` : Use the pulled latest HertzBeat-Collector official application mirror to start the container. **Use `quay.io/tancloud/hertzbeat-collector` instead if you pull `quay.io` docker image.** - -8. Access `http://localhost:1157` and you will see the registered new collector in dashboard. - -**HAVE FUN** - -### FAQ - -**The most common problem is network problems, please check in advance** - -1. **MYSQL, TDENGINE, IoTDB and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** - The problems lies in Docker container failed to visit and connect localhost port. Because the docker default network mode is Bridge mode which can't access local machine through localhost. - -> Solution A：Configure application.yml. Change database connection address from localhost to external IP of the host machine. -> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` - -2. **According to the process deploy，visit no interface** - Please refer to the following points to troubleshoot issues： - -> 1：If you switch to dependency service MYSQL database，check whether the database is created and started successfully. -> 2：Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. -> 3：`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. - -3. **Log an error TDengine connection or insert SQL failed** - -> 1：Check whether database account and password configured is correct, the database is created. -> 2：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - -4. **Historical monitoring charts have been missing data for a long time** - -> 1：Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. -> 2：Check whether Tdengine database `hertzbeat` is created. -> 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. - -5. If the history chart on the monitoring page is not displayed，popup [please configure time series database] - -> As shown in the popup window，the premise of history chart display is that you need install and configure hertzbeat's dependency service - IoTDB or TDengine database. -> Installation and initialization this database refer to [TDengine Installation](tdengine-init) or [IoTDB Installation](iotdb-init) - -6. The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed - -> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. - -7. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] - -> Please check if the configuration parameters are correct -> Is iot-db or td-engine enable set to true -> Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed -> You can check the startup logs according to the logs directory diff --git a/home/versioned_docs/version-v1.4.x/start/greptime-init.md b/home/versioned_docs/version-v1.4.x/start/greptime-init.md deleted file mode 100644 index 5102ecfe6b7..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/greptime-init.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: greptime-init -title: Use Time Series Database GreptimeDB to Store Metrics Data (Optional) -sidebar_label: Use GreptimeDB Store Metrics ---- - -HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) -We recommend VictoriaMetrics for long term support. - -GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. - -It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage. - -**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** - -### Install GreptimeDB via Docker - -> Refer to the official website [installation tutorial](https://docs.greptime.com/getting-started/overview) -> -> 1. Download and install Docker environment -> Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). -> After the installation you can check if the Docker version normally output at the terminal. -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Install GreptimeDB with Docker - -```shell -$ docker run -p 4000-4004:4000-4004 \ - -p 4242:4242 -v /opt/greptimedb:/tmp/greptimedb \ - --name greptime \ - greptime/greptimedb standalone start \ - --http-addr 0.0.0.0:4000 \ - --rpc-addr 0.0.0.0:4001 \ -``` - -`-v /opt/greptimedb:/tmp/greptimedb` is local persistent mount of greptimedb data directory. `/opt/greptimedb` should be replaced with the actual local directory. -use```$ docker ps``` to check if the database started successfully - -### Configure the database connection in hertzbeat `application.yml` configuration file - -1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.greptime` data source parameters, URL account and password. - -```yaml -warehouse: - store: - # disable jpa - jpa: - enabled: false - # enable greptime - greptime: - enabled: true - endpoint: localhost:4001 -``` - -2. Restart HertzBeat - -### FAQ - -1. Do both the time series databases Greptime, IoTDB or TDengine need to be configured? Can they both be used? - -> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. diff --git a/home/versioned_docs/version-v1.4.x/start/influxdb-init.md b/home/versioned_docs/version-v1.4.x/start/influxdb-init.md deleted file mode 100644 index 05f6b44d876..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/influxdb-init.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: influxdb-init -title: Use Time Series Database InfluxDB to Store Metrics Data (Optional) -sidebar_label: Use InfluxDB Store Metrics ---- - -HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) -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.** -Note⚠️ Need InfluxDB 1.x Version. - -### 1. Use HuaweiCloud GaussDB For Influx - -> Use [HuaweiCloud GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) -> -> Get the `GaussDB For Influx` service url, username and password config. - -⚠️Note `GaussDB For Influx` enable SSL default, the service url should use `https:` - -### 2. Install TDengine via Docker - -> Refer to the official website [installation tutorial](https://hub.docker.com/_/influxdb) -> -> 1. Download and install Docker environment -> Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). -> After the installation you can check if the Docker version normally output at the terminal. -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Install InfluxDB with Docker -> -> ``` -> $ docker run -p 8086:8086 \ -> -v /opt/influxdb:/var/lib/influxdb \ -> influxdb:1.8 -> ``` -> -> `-v /opt/influxdb:/var/lib/influxdb` is local persistent mount of InfluxDB data directory. `/opt/influxdb` should be replaced with the actual local directory. -> use```$ docker ps``` to check if the database started successfully - -### Configure the database connection in hertzbeat `application.yml` configuration file - -1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.influxdb` data source parameters, URL account and password. - -```yaml -warehouse: - store: - # disable jpa - jpa: - enabled: false - # enable influxdb - influxdb: - enabled: true - server-url: http://localhost:8086 - username: root - password: root - expire-time: '30d' - replication: 1 -``` - -2. Restart HertzBeat - -### FAQ - -1. Do both the time series databases InfluxDB, IoTDB and TDengine need to be configured? Can they both be used? - -> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. diff --git a/home/versioned_docs/version-v1.4.x/start/iotdb-init.md b/home/versioned_docs/version-v1.4.x/start/iotdb-init.md deleted file mode 100644 index 7c3f7bd4e38..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/iotdb-init.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: iotdb-init -title: Use Time Series Database IoTDB to Store Metrics Data (Optional) -sidebar_label: Use IoTDB Store Metrics ---- - -HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) -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** -**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** - -> If you already have an IoTDB environment, you can skip directly to the YML configuration step. - -### Install IoTDB via Docker - -> Refer to the official website [installation tutorial](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) -> -> 1. Download and install Docker environment -> Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). -> After the installation you can check if the Docker version normally output at the terminal. -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Install IoTDB via Docker - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - -`-v /opt/iotdb/data:/iotdb/data` is local persistent mount of IotDB data directory.`/iotdb/data` should be replaced with the actual local directory. -use```$ docker ps``` to check if the database started successfully - -3. Configure the database connection in hertzbeat `application.yml`configuration file - - Modify `hertzbeat/config/application.yml` configuration file - Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Config the `warehouse.store.jpa.enabled` `false`. Replace `warehouse.store.iot-db` data source parameters, HOST account and password. - -``` -warehouse: - store: - # disable JPA - jpa: - enabled: false - # enable iot-db - iot-db: - enabled: true - host: 127.0.0.1 - rpc-port: 6667 - username: root - password: root - # config.org.apache.hertzbeat.warehouse.IotDbVersion: V_0_13 || V_1_0 - version: V_0_13 - query-timeout-in-ms: -1 - # default '7776000000'（90days,unit:ms,-1:no-expire） - expire-time: '7776000000' -``` - -4. Restart HertzBeat - -### FAQ - -1. Do both the time series databases IoTDB and TDengine need to be configured? Can they both be used? - -> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. - -2. The historical chart of the monitoring page is not displayed, and pops up [Unable to provide historical chart data, please configure to rely on the time series database] - -> As shown in the pop-up window, the premise of displaying the history chart is to install and configure the dependent services of hertzbeat - IotDB database or TDengine database - -3. The TDengine database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure the dependent time series database] - -> Please check if the configuration parameters are correct -> Is td-engine enable set to true -> Note⚠️If both hertzbeat and TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed -> You can check the startup logs according to the logs directory diff --git a/home/versioned_docs/version-v1.4.x/start/mysql-change.md b/home/versioned_docs/version-v1.4.x/start/mysql-change.md deleted file mode 100644 index e79b98cd264..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/mysql-change.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: mysql-change -title: Use MYSQL Replace H2 Database to Store Metadata(Optional) -sidebar_label: Use MYSQL Instead of H2 ---- - -MYSQL is a reliable relational database. In addition to default built-in H2 database, HertzBeat allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. - -> If you have the MYSQL environment, can be directly to database creation step. - -### Install MYSQL via Docker - -1. Download and install the Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 - After the installation you can check if the Docker version normally output at the terminal. - - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -2. Install MYSQl with Docker - - ``` - docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7 - ``` - - `-v /opt/data:/var/lib/mysql` is local persistent mount of mysql data directory. `/opt/data` should be replaced with the actual local directory. - use ```$ docker ps``` to check if the database started successfully - -### Database creation - -1. Enter MYSQL or use the client to connect MYSQL service - `mysql -uroot -p123456` -2. Create database named hertzbeat - `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` -3. Check if hertzbeat database has been successfully created - `show databases;` - -### Modify hertzbeat's configuration file application.yml and switch data source - -1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file - Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `spring.database` data source parameters, URL account and password. - -```yaml -spring: - datasource: - driver-class-name: org.h2.Driver - username: sa - password: 123456 - url: jdbc:h2:./data/hertzbeat;MODE=MYSQL -``` - -Specific replacement parameters are as follows and you need to configure account according to the mysql environment: - -```yaml -spring: - datasource: - driver-class-name: com.mysql.cj.jdbc.Driver - username: root - password: 123456 - url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false -``` - -**Start HertzBeat visit 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 deleted file mode 100644 index f86a68c6362..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/package-deploy.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -id: package-deploy -title: Install HertzBeat via Package -sidebar_label: Install via Package ---- - -> You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64. - -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) - Unzip the installation package to the host eg: /opt/hertzbeat - - ``` - $ tar zxvf hertzbeat-xx.tar.gz - or - $ unzip -o hertzbeat-xx.zip - ``` - - Modify the configuration file `hertzbeat/config/application.yml` params according to your needs. - - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` - - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) - - **Highly recommended** From now on we will mainly support VictoriaMetrics as a time-series database, if you need to use the time series database VictoriaMetrics to store metric data, you need to replace the `warehouse.store.victoria-metrics` parameter in `application.yml` for specific steps, see [Using VictoriaMetrics to store metrics data](victoria-metrics-init) - - **Recommended** If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) - - **Recommended** If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) - -3. Configure the account file(optional) - HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` - If you need add, delete or modify account or password, configure `hertzbeat/config/sureness.yml`. Ignore this step without this demand. - For detail steps, please refer to [Configure Account Password](account-modify) - -4. Start the service - Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. - - ``` - ./startup.sh - ``` - -5. Begin to explore HertzBeat - - Access using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! - -6. Deploy collector clusters (Optional) - - - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [Download](https://hertzbeat.apache.org/docs/download) - - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` - - ```yaml - collector: - dispatch: - entrance: - netty: - enabled: true - identity: ${IDENTITY:} - mode: ${MODE:public} - manager-host: ${MANAGER_HOST:127.0.0.1} - manager-port: ${MANAGER_PORT:1158} - ``` - - - Run command `$ ./bin/startup.sh` or `bin/startup.bat` - - Access `http://localhost:1157` and you will see the registered new collector in dashboard - -**HAVE FUN** - -### FAQ - -1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance** - - Install JAVA runtime environment-refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html) - requirement：JDK11 ENV - download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) - After installation use command line to check whether you install it successfully. - - ``` - $ java -version - java version "11.0.12" - Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) - - ``` - -2. **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`. -> 3：Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. - -3. **Log an error TDengine connection or insert SQL failed** - -> 1：Check whether database account and password configured is correct, the database is created. -> 2：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - -4. **Monitoring historical charts with no data for a long time** - -> 1: Whether the time series database is configured or not, if it is not configured, there is no historical chart data. -> 2: If you are using Tdengine, check whether the database `hertzbeat` of Tdengine is created. -> 3: HertzBeat's configuration file `application.yml`, the dependent services in it, the time series, the IP account password, etc. are configured correctly. diff --git a/home/versioned_docs/version-v1.4.x/start/postgresql-change.md b/home/versioned_docs/version-v1.4.x/start/postgresql-change.md deleted file mode 100644 index d06d040ee7e..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/postgresql-change.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: postgresql-change -title: Use PostgreSQL Replace H2 Database to Store Metadata(Optional) -sidebar_label: Use PostgreSQL Instead of H2 ---- - -PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, HertzBeat allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information. - -> If you have the PostgreSQL environment, can be directly to database creation step. - -### Install PostgreSQL via Docker - -1. Download and install the Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 - After the installation you can check if the Docker version normally output at the terminal. - - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -2. Install PostgreSQL with Docker - - ``` - docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 - ``` - - use```$ docker ps```to check if the database started successfully - -3. Create database in container manually or with [script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-iotdb/conf/sql/schema.sql). - -### Database creation - -1. Enter postgreSQL or use the client to connect postgreSQL service - - ``` - su - postgres - psql - ``` - -2. Create database named hertzbeat - `CREATE DATABASE hertzbeat;` -3. Check if hertzbeat database has been successfully created - `\l` - -### Modify hertzbeat's configuration file application.yml and switch data source - -1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file - Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `spring.database` data source parameters, URL account and password. - -```yaml -spring: - datasource: - driver-class-name: org.h2.Driver - username: sa - password: 123456 - url: jdbc:h2:./data/hertzbeat;MODE=MYSQL -``` - -Specific replacement parameters are as follows and you need to configure account, ip, port according to the postgresql environment: - -```yaml -spring: - config: - activate: - on-profile: prod - datasource: - driver-class-name: org.postgresql.Driver - username: root - password: 123456 - url: jdbc:postgresql://127.0.0.1:5432/hertzbeat - hikari: - max-lifetime: 120000 - - jpa: - database: postgresql - hibernate: - ddl-auto: update - properties: - hibernate: - dialect: org.hibernate.dialect.PostgreSQLDialect -``` - -**Start HertzBeat visit 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 deleted file mode 100644 index 5c3b8239a82..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/quickstart.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: quickstart -title: Quick Start -sidebar_label: Quick Start ---- - -### 🐕 Quick Start - -- If you wish to deploy HertzBeat locally, please refer to the following Deployment Documentation for instructions. - -### 🍞 Install HertzBeat - -> HertzBeat supports installation through source code, docker or package, cpu support X86/ARM64. - -##### 1：Install quickly via docker - -1. Just one command to get started: - -```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` - -```or use quay.io (if dockerhub network connect timeout)``` - -```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` - -2. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` - -3. Deploy collector clusters - -``` -docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector -``` - -- `-e IDENTITY=custom-collector-name` : set the collector unique identity name. -- `-e MODE=public` : set the running mode(public or private), public cluster or private cloud-edge. -- `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. - -Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - -##### 2：Install via package - -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` -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) - - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` - - ```yaml - collector: - dispatch: - entrance: - netty: - enabled: true - identity: ${IDENTITY:} - mode: ${MODE:public} - manager-host: ${MANAGER_HOST:127.0.0.1} - manager-port: ${MANAGER_PORT:1158} - ``` - - - Run command `$ ./bin/startup.sh` or `bin/startup.bat` - - Access `http://localhost:1157` and you will see the registered new collector in dashboard - -Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.com/docs/start/package-deploy) - -##### 3：Start via source code - -1. Local source code debugging needs to start the back-end project `manager` and the front-end project `web-app`. -2. Backend：need `maven3+`, `java11`, `lombok`, start the `manager` service. -3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. -4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` - -Detailed steps refer to [CONTRIBUTING](../others/contributing) - -##### 4：Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose - -Install and deploy the mysql database, iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose). - -Detailed steps refer to [Install via Docker-Compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) - -##### 5. Install All(hertzbeat+collector+mysql+iotdb) via kubernetes helm charts - -Install HertzBeat cluster in a Kubernetes cluster by Helm chart. - -Detailed steps refer to [Artifact Hub](https://artifacthub.io/packages/helm/hertzbeat/hertzbeat) - -**HAVE FUN** diff --git a/home/versioned_docs/version-v1.4.x/start/rainbond-deploy.md b/home/versioned_docs/version-v1.4.x/start/rainbond-deploy.md deleted file mode 100644 index d1fbf4763fa..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/rainbond-deploy.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: rainbond-deploy -title: Use Rainbond Deploy HertzBeat -sidebar_label: Install via Rainbond ---- - -If you are unfamiliar with Kubernetes, and want to install HertzBeat in Kubernetes, you can use Rainbond to deploy. Rainbond is a cloud-native application management platform built on Kubernetes and simplifies the application deployment to Kubernetes. - -## Prerequisites - -To install Rainbond, please refer to [Rainbond Quick Install](https://www.rainbond.com/docs/quick-start/quick-install)。 - -## Deploy HertzBeat - -After logging in Rainbond, click Market in the left menu, switch to open source app store, and search HertzBeat in the search box, and click the Install button. - -![](/img/docs/start/install-to-rainbond-en.png) - -Fill in the following information, and click Confirm button to install. - -* Team: select a team or create a new team -* Cluster: select a cluster -* Application: select an application or create a new application -* Version: select a version - -After installation, HertzBeat can be accessed via the Access button. - -![](/img/docs/start/hertzbeat-topology-en.png) - -:::tip -HertzBeat installed via Rainbond, External Mysql database and Redis and IoTDB are used by default, The HertzBeat configuration file is also mounted, which can be modified in `Components -> Environment Configuration -> Configuration File Settings`. -::: 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 deleted file mode 100644 index f3acc57b71e..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -id: ssl-cert-practice -title: SSL Certificate Monitor Practice -sidebar_label: Practice Example ---- - -Most websites now support HTTPS by default. The certificate we apply for is usually 3 months or 1 year. It is easy to expire the SSL certificate over time, but we did not find it the first time, or did not update the certificate in time before it expired. - -This article introduces how to use the hertzbeat monitoring tool to detect the validity period of our website's SSL certificate, and send us a warning message when the certificate expires or a few days before the certificate expires. - -#### What is HertzBeat - -HertzBeat is a real-time monitoring tool with powerful custom monitoring capabilities without Agent. Website monitoring, PING connectivity, port availability, database, operating system, middleware, API monitoring, threshold alarms, alarm notification (email, WeChat, Ding Ding Feishu). - -**Official website: | ** - -github: -gitee: - -#### Install HertzBeat - -1. If you don't want to install, you can use the cloud service directly [TanCloud exploration cloud console.tancloud.cn](https://console.tancloud.cn) - -2. The `docker` environment can be installed with just one command - -`docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` - -3. After the installation is successful, the browser can access `localhost:1157` to start, the default account password is `admin/hertzbeat` - -#### Monitoring SSL certificates - -1. Click Add SSL Certificate Monitor - -> System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate - -![](/img/docs/start/ssl_1.png) - -2. Configure the monitoring website - -> Here we take the example of monitoring Baidu website, configure monitoring host domain name, name, collection interval, etc. -> Click OK Note ⚠️Before adding, it will test the connectivity of the website by default, and the connection will be successful before adding. Of course, you can also gray out the **Test or not** button. - -![](/img/docs/start/ssl_2.png) - -3. View the detection index data - -> In the monitoring list, you can view the monitoring status, and in the monitoring details, you can view the metric data chart, etc. - -![](/img/docs/start/ssl_3.png) - -![](/img/docs/start/ssl_11.png) - -4. Set the threshold (triggered when the certificate expires) - -> System Page -> Alarms -> Alarm Thresholds -> New Thresholds - -![](/img/docs/start/ssl_4.png) - -> Configure the threshold, select the SSL certificate metric object, configure the alarm expression-triggered when the metric `expired` is `true`, that is, `equals(expired,"true")`, set the alarm level notification template information, etc. - -![](/img/docs/start/ssl_5.png) - -> Associating thresholds with monitoring, in the threshold list, set which monitoring this threshold applies to. - -![](/img/docs/start/ssl_6.png) - -5. Set the threshold (triggered one week before the certificate expires) - -> In the same way, add a new configuration threshold and configure an alarm expression - when the metric expires timestamp `end_timestamp`, the `now()` function is the current timestamp, if the configuration triggers an alarm one week in advance: `end_timestamp <= (now( ) + 604800000)` , where `604800000` is the 7-day total time difference in milliseconds. - -![](/img/docs/start/ssl_7.png) - -> Finally, you can see the triggered alarm in the alarm center. - -![](/img/docs/start/ssl_8.png) - -6. Alarm notification (in time notification via Dingding WeChat Feishu, etc.) - -> Monitoring Tool -> Alarm Notification -> New Receiver - -![](/img/docs/start/ssl_10.png) - -For token configuration such as Dingding WeChat Feishu, please refer to the help document - - - - -> Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured - -![](/img/docs/start/ssl_11.png) - -7. OK When the threshold is triggered, we can receive the corresponding alarm message. If there is no notification, you can also view the alarm information in the alarm center. - ----- - -#### 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: ** - -**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 deleted file mode 100644 index f443a72eb56..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/tdengine-init.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: tdengine-init -title: Use Time Series Database TDengine to Store Metrics Data (Optional) -sidebar_label: Use TDengine Store Metrics ---- - -HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) -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⚠️ Need TDengine 3.x Version. - -> If you have TDengine environment, can directly skip to create a database instance. - -### Install TDengine via Docker - -> Refer to the official website [installation tutorial](https://docs.taosdata.com/get-started/docker/) -> -> 1. Download and install Docker environment -> Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). -> After the installation you can check if the Docker version normally output at the terminal. -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` -> -> 2. Install TDengine with Docker -> -> ```shell -> $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ -> -v /opt/taosdata:/var/lib/taos \ -> --name tdengine -e TZ=Asia/Shanghai \ -> tdengine/tdengine:3.0.4.0 -> ``` -> -> `-v /opt/taosdata:/var/lib/taos` is local persistent mount of TDengine data directory. `/opt/taosdata` should be replaced with the actual local directory. -> `-e TZ="Asia/Shanghai"` can set time zone for TDengine.Set up the corresponding time zone you want. -> use```$ docker ps``` to check if the database started successfully - -### Create database instance - -1. Enter database Docker container - - ``` - docker exec -it tdengine /bin/bash - ``` - -2. Create database named hertzbeat - After entering the container，execute `taos` command as follows: - - ``` - root@tdengine-server:~/TDengine-server# taos - Welcome to the TDengine shell from Linux, Client Version - Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. - taos> - ``` - - execute commands to create database - - ``` - taos> show databases; - taos> CREATE DATABASE hertzbeat KEEP 90 DURATION 10 BUFFER 16; - ``` - - The above statements will create a database named hertzbeat. The data will be saved for 90 days (more than 90 days data will be automatically deleted). - A data file every 10 days, memory blocks buffer is 16MB. - -3. Check if hertzbeat database has been created success - - ``` - taos> show databases; - taos> use hertzbeat; - ``` - -**Note⚠️If you install TDengine using package** - -> In addition to start the server，you must execute `systemctl start taosadapter` to start adapter - -### Configure the database connection in hertzbeat `application.yml` configuration file - -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 -warehouse: - store: - # disable jpa - jpa: - enabled: false - # enable td-engine - td-engine: - enabled: true - driver-class-name: com.taosdata.jdbc.rs.RestfulDriver - url: jdbc:TAOS-RS://localhost:6041/hertzbeat - username: root - password: taosdata -``` - -2. Restart HertzBeat - -### FAQ - -1. Do both the time series databases IoTDB and TDengine need to be configured? Can they both be used? - -> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. - -2. The historical chart of the monitoring page is not displayed, and pops up [Unable to provide historical chart data, please configure to rely on the time series database] - -> As shown in the pop-up window, the premise of displaying the history chart is to install and configure the dependent services of hertzbeat - IotDB database or TDengine database - -3. The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed - -> Please confirm whether the installed TDengine version is 3.x, version 2.x are not compatible. - -4. The TDengine database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure the dependent time series database] - -> Please check if the configuration parameters are correct -> 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/upgrade.md b/home/versioned_docs/version-v1.4.x/start/upgrade.md deleted file mode 100644 index 101564dc00b..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/upgrade.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: upgrade -title: HertzBeat New Version Upgrade -sidebar_label: Version Upgrade Guide ---- - -**HertzBeat Release Version List** - -- [Download](https://hertzbeat.apache.org/docs/download) -- [Gitee Release](https://gitee.com/hertzbeat/hertzbeat/releases) -- [DockerHub Release](https://hub.docker.com/r/apache/hertzbeat/tags) -- [Docker quay.io Release](https://quay.io/repository/apache/hertzbeat?tab=tags) - -HertzBeat's metadata information is stored in H2 or Mysql, PostgreSQL relational databases, and the collected metric data is stored in time series databases such as TDengine and IotDB. - -**You need to save and back up the data files of the database and monitoring templates yml files before upgrading** - -### Upgrade For Docker Deploy - -1. If using custom monitoring templates - - Need to back up docker templates directory `docker cp hertzbeat:/opt/hertzbeat/define ./define` in the container `/opt/hertzbeat/define` - - `docker cp hertzbeat:/opt/hertzbeat/define ./define` - - And mount the template define directory when docker start `-v $(pwd)/define:/opt/hertzbeat/define` - - `-v $(pwd)/define:/opt/hertzbeat/define` -2. If using the built-in default H2 database - - Need to mount or back up `-v $(pwd)/data:/opt/hertzbeat/data` database file directory in the container `/opt/hertzbeat/data` - - Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image - - Refer to [Docker installation of HertzBeat](docker-deploy) to create a new container using a new image. Note that the database file directory needs to be mounted `-v $(pwd)/data:/opt/hertzbeat/data` -3. If using external relational database Mysql, PostgreSQL - - No need to mount the database file directory in the backup container - - Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image - - Refer to [Docker installation HertzBeat](docker-deploy) to create a new container using the new image, and configure the database connection in `application.yml` - -### Upgrade For Package Deploy - -1. If using the built-in default H2 database - - Back up the database file directory under the installation package `/opt/hertzbeat/data` - - If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define` - - `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package - - Refer to [Installation package to install HertzBeat](package-deploy) to start using the new installation package -2. If using external relational database Mysql, PostgreSQL - - No need to back up the database file directory under the installation package - - If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define` - - `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package - - Refer to [Installation package to install HertzBeat](package-deploy) to start with the new installation package and configure the database connection in `application.yml` - -**HAVE FUN** diff --git a/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md b/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md deleted file mode 100644 index 0c4c968371a..00000000000 --- a/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: victoria-metrics-init -title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended) -sidebar_label: Use VictoriaMetrics Store Metrics ---- - -HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) -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** -**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** - -> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step. - -### Install VictoriaMetrics via Docker - -> Refer to the official website [installation tutorial](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) -> -> 1. Download and install Docker environment -> Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). -> After the installation you can check if the Docker version normally output at the terminal. -> -> ``` -> $ docker -v -> Docker version 20.10.12, build e91ed57 -> ``` - -2. Install VictoriaMetrics via Docker - -```shell -$ docker run -d -p 8428:8428 \ - -v $(pwd)/victoria-metrics-data:/victoria-metrics-data \ - --name victoria-metrics \ - victoriametrics/victoria-metrics:v1.95.1 -``` - -`-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` is local persistent mount of VictoriaMetrics data directory -use```$ docker ps``` to check if the database started successfully - -3. Configure the database connection in hertzbeat `application.yml`configuration file - - Modify `hertzbeat/config/application.yml` configuration file - Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Config the `warehouse.store.jpa.enabled` `false`. Replace `warehouse.store.victoria-metrics` data source parameters, HOST account and password. - -```yaml -warehouse: - store: - # disable JPA - jpa: - enabled: false - # enable victoria-metrics - victoria-metrics: - enabled: true - url: http://localhost:8428 - username: root - password: root -``` - -4. Restart HertzBeat - -### FAQ - -1. Do both the time series databases need to be configured? Can they both be used? - -> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which can affects the historical chart data. diff --git a/home/versioned_docs/version-v1.4.x/template.md b/home/versioned_docs/version-v1.4.x/template.md deleted file mode 100644 index 92fba55542c..00000000000 --- a/home/versioned_docs/version-v1.4.x/template.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: template -title: Monitoring Template Here -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. -> Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? - -Here is the architecture. - -![hertzBeat](/img/docs/hertzbeat-arch.png) - -**We define all monitoring collection types (mysql, website, jvm, k8s) as yml templates, and users can import these templates into the hertzbeat system to support corresponding types of monitoring, which is very convenient!** - -![](/img/docs/advanced/extend-point-1.png) - -**Welcome everyone to contribute your customized general monitoring type YML template during use. The available templates are as follows:** - -### Application service monitoring - - 👉 [Website monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml)
- 👉 [HTTP API](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml)
- 👉 [PING Connectivity](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml)
- 👉 [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml)
- 👉 [Full site monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml)
- 👉 [SSL Cert monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml)
- 👉 [JVM monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml)
- 👉 [SpringBoot2.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml)
- 👉 [SpringBoot3.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml)
- 👉 [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml)
- -### Database monitoring - - 👉 [MYSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml)
- 👉 [MariaDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml)
- 👉 [PostgreSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml)
- 👉 [SqlServer database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml)
- 👉 [Oracle database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml)
- 👉 [DM database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml)
- 👉 [OpenGauss database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml)
- 👉 [IoTDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml)
- 👉 [ElasticSearch database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml)
- 👉 [MongoDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml)
- 👉 [ClickHouse database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml)
- 👉 [Redis database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml)
- 👉 [Redis Sentinel database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml)
- 👉 [Redis Cluster database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml)
- -### Operating system monitoring - - 👉 [Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml)
- 👉 [Windows operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml)
- 👉 [Ubuntu operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml)
- 👉 [Centos operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml)
- 👉 [EulerOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml)
- 👉 [Fedora CoreOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml)
- 👉 [OpenSUSE operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml)
- 👉 [Rocky Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml)
- 👉 [Red Hat operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml)
- 👉 [FreeBSD operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml)
- 👉 [AlmaLinux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml)
- 👉 [Debian operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml)
- -### Middleware monitoring - - 👉 [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml)
- 👉 [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml)
- 👉 [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml)
- 👉 [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml)
- 👉 [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml)
- 👉 [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml)
- 👉 [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml)
- 👉 [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml)
- 👉 [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml)
- 👉 [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml)
- -### CloudNative monitoring - - 👉 [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml)
- 👉 [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml)
- -### Network monitoring - - 👉 [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml)
- 👉 [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml)
- 👉 [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml)
- 👉 [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml)
- 👉 [H3CSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
- ---- - -**Have Fun!** diff --git a/home/versioned_docs/version-v1.5.x/community/how-to-release.md b/home/versioned_docs/version-v1.5.x/community/how-to-release.md index 71583c0d36c..94c919d30f0 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 @@ -168,6 +168,8 @@ $ svn ci -m "add gpg key for muchunjin" ## 3. Prepare material package & release +### Build Package + #### 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 @@ -228,6 +230,8 @@ release-1.6.0-rc1 The archive package is here `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz` +### Sign package + #### 3.5 Sign binary and source packages > The `gpg -u 33545C76` `33545C76` is your gpg secret ID, see from `gpg --keyid-format SHORT --list-keys` @@ -333,7 +337,7 @@ svn commit -m "release for HertzBeat 1.6.0" ## 4. Enter the community voting stage -#### 4.1 Send a Community Vote Email +### 4.1 Send a Community Vote Email Send a voting email in the community requires at least three `+1` and no `-1`. @@ -525,9 +529,9 @@ 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 -## 4. Complete the final publishing steps +## 5. Complete the final publishing steps -#### 4.1 Migrating source and binary packages +### 5.1 Migrating source and binary packages ```shell svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0 -m "transfer packages for 1.6.0-RC1" @@ -573,27 +577,32 @@ The rename the release-1.6.0-rc1 branch to release-1.6.0. > `Send to`:
> `cc`:
-> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0
+> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released
> `Body`: ``` -Hi Incubator Community, +Hi Community, We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. -Once again I would like to express my thanks to your help. +Thanks again for your help. -Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +Apache HertzBeat (https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. -Download Links: https://hertzbeat.apache.org/download/ +Download Link: +https://hertzbeat.apache.org/docs/download/ -Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 +Release Note: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0 + +Website: +https://hertzbeat.apache.org/ HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues - Mailing list: dev@hertzbeat.apache.org --- Apache HertzBeat Team - +--- Best, ChunJin Mu ``` 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 3d6a5fe4b8e..5eb31844648 100644 --- a/home/versioned_docs/version-v1.5.x/help/dns.md +++ b/home/versioned_docs/version-v1.5.x/help/dns.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito **Protocol Use：DNS** -### Configuration parameter +## Configuration parameter | Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| @@ -24,9 +24,9 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito | Bind Tags | Used to classify and manage monitoring resources. | | Description remarks | For more information about identifying and describing this monitoring, users can note information here. | -### Collection Metrics +## Collection Metrics -#### Metrics Set：Header +### Metrics Set：Header | Metric name | Metric unit | Metric help description | |-------------------------|-------------|---------------------------------------------------| 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 3cb2336e768..d7e6b657ea6 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 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 fc7f7925ca6..3c3abeee5a8 100644 --- a/home/versioned_docs/version-v1.5.x/help/ntp.md +++ b/home/versioned_docs/version-v1.5.x/help/ntp.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito **Protocol Use：NTP** -### Configuration parameter +## Configuration parameter | Parameter name | Parameter help description | |---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 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 6cbaffc43a6..319e046b2ea 100644 --- a/home/versioned_docs/version-v1.5.x/start/quickstart.md +++ b/home/versioned_docs/version-v1.5.x/start/quickstart.md @@ -8,7 +8,7 @@ sidebar_label: Quick Start - If you wish to deploy Apache HertzBeat (incubating) locally, please refer to the following Deployment Documentation for instructions. -### 🍞 Install HertzBeat +#### 🍞 Install HertzBeat > Apache HertzBeat (incubating) supports installation through source code, docker or package, cpu support X86/ARM64. diff --git a/home/versioned_sidebars/version-v1.4.x-sidebars.json b/home/versioned_sidebars/version-v1.4.x-sidebars.json deleted file mode 100644 index 8d1841e07a5..00000000000 --- a/home/versioned_sidebars/version-v1.4.x-sidebars.json +++ /dev/null @@ -1,240 +0,0 @@ -{ - "docs": [ - { - "type": "category", - "label": "quickstart", - "items": [ - "introduce", - { - "type": "link", - "label": "Cloud Service", - "href": "https://console.tancloud.cn" - }, - "start/quickstart", - "start/docker-deploy", - "start/package-deploy", - { - "type": "link", - "label": "Install via HuaweiCloud", - "href": "https://marketplace.huaweicloud.com/contents/0477015c-ad63-4522-a308-816861769f0a#productid=OFFI863735781612109824" - }, - "start/rainbond-deploy", - { - "type": "link", - "label": "Install via Helm", - "href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat" - }, - "start/upgrade", - "start/victoria-metrics-init", - "start/iotdb-init", - "start/tdengine-init", - "start/greptime-init", - "start/influxdb-init", - "start/mysql-change", - "start/postgresql-change", - "start/account-modify", - "start/custom-config", - "start/ssl-cert-practice" - ] - }, - { - "type": "category", - "label": "custom", - "items": [ - "advanced/extend-point", - "advanced/extend-tutorial", - { - "type": "category", - "label": "http", - "items": [ - "advanced/extend-http", - "advanced/extend-http-default", - "advanced/extend-http-jsonpath", - "advanced/extend-http-example-hertzbeat", - "advanced/extend-http-example-token" - ] - }, - { - "type": "category", - "label": "jdbc", - "items": [ - "advanced/extend-jdbc" - ] - }, - { - "type": "category", - "label": "ssh", - "items": [ - "advanced/extend-ssh" - ] - }, - { - "type": "category", - "label": "jmx", - "items": [ - "advanced/extend-jmx" - ] - }, - { - "type": "category", - "label": "snmp", - "items": [ - "advanced/extend-snmp" - ] - }, - { - "type": "category", - "label": "push", - "items": [ - "advanced/extend-push" - ] - } - ] - }, - { - "type": "doc", - "id": "template" - }, - { - "type": "category", - "label": "help", - "items": [ - "help/guide", - { - "type": "category", - "label": "service", - "items": [ - "help/website", - "help/api", - "help/ping", - "help/port", - "help/fullsite", - "help/ssl_cert", - "help/nginx", - "help/pop3", - "help/smtp", - "help/ntp" - ] - }, - { - "type": "category", - "label": "program", - "items": [ - "help/jvm", - "help/springboot2", - "help/dynamic_tp" - ] - }, - { - "type": "category", - "label": "database", - "items": [ - "help/mysql", - "help/mariadb", - "help/postgresql", - "help/sqlserver", - "help/oracle", - "help/dm", - "help/opengauss", - "help/nebulaGraph" - ] - }, - { - "type": "category", - "label": "cache", - "items": [ - "help/redis", - "help/memcached" - ] - }, - { - "type": "category", - "label": "os", - "items": [ - "help/linux", - "help/windows", - "help/ubuntu", - "help/centos" - ] - }, - { - "type": "category", - "label": "mid", - "items": [ - "help/zookeeper", - "help/shenyu", - "help/rabbitmq", - "help/activemq", - "help/spring_gateway" - ] - }, - { - "type": "category", - "label": "bigdata", - "items": [ - "help/spark", - "help/doris_be", - "help/doris_fe", - "help/hadoop", - "help/iotdb", - "help/hive", - "help/airflow" - ] - }, - { - "type": "category", - "label": "webserver", - "items": [ - "help/tomcat", - "help/jetty" - ] - }, - { - "type": "category", - "label": "cloud-native", - "items": [ - "help/docker", - "help/kubernetes" - ] - }, - { - "type": "category", - "label": "threshold", - "items": [ - "help/alert_threshold", - "help/alert_threshold_expr" - ] - }, - { - "type": "category", - "label": "notice", - "items": [ - "help/alert_email", - "help/alert_webhook", - "help/alert_discord", - "help/alert_slack", - "help/alert_telegram", - "help/alert_wework", - "help/alert_dingtalk", - "help/alert_feishu", - "help/alert_console", - "help/alert_enterprise_wechat_app", - "help/alert_smn" - ] - }, - "help/issue" - ] - }, - { - "type": "category", - "label": "Others", - "items": [ - "others/developer", - "others/contributing", - "others/contact", - "others/sponsor", - "others/resource" - ] - } - ] -} diff --git a/home/versions.json b/home/versions.json index 37c425aa229..b0190cee534 100644 --- a/home/versions.json +++ b/home/versions.json @@ -1,4 +1,3 @@ [ - "v1.5.x", - "v1.4.x" + "v1.5.x" ] diff --git a/manager/pom.xml b/manager/pom.xml index 2e0e1120445..34debeb7894 100644 --- a/manager/pom.xml +++ b/manager/pom.xml @@ -29,14 +29,6 @@ true - 3.2.0 - 3.3.0 - 1.9.22 - 1.1.0 - 1.0 - 4.3.0 - 3.1.37 - 3.23.5 diff --git a/plugin/pom.xml b/plugin/pom.xml index 023225ceb8f..5f365c6907a 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -28,8 +28,6 @@ hertzbeat-plugin ${project.artifactId} - 3.2.0 - 3.3.0 @@ -46,7 +44,7 @@ org.apache.maven.plugins maven-assembly-plugin - 3.3.0 + ${maven-assembly-plugin.version} src/main/resources/assembly/assembly.xml diff --git a/pom.xml b/pom.xml index ef78581687a..1a354117606 100644 --- a/pom.xml +++ b/pom.xml @@ -95,6 +95,9 @@ 17 ${java.version} ${java.version} + 3.2.0 + 3.3.0 + 2.1.1 3.8.1 @@ -140,6 +143,31 @@ 3.10.0 0.8.11 2.40.0 + + 4.3.0 + 4.1.1 + 1.4.2 + 2.13.1 + 0.3.0 + 3.6.7 + 4.9.4 + 3.5.2 + 1.4.5 + 2.2.1 + 3.6.0 + 4.0.2 + 1.0.0 + 1.1.0 + 3.1.37 + 3.23.5 + + + 0.13.3 + 2.23 + 3.0.5 + 3.0.0 + 0.7.3 + 8.0.33 diff --git a/push/pom.xml b/push/pom.xml index 5ae67fece70..d3be8d935b2 100644 --- a/push/pom.xml +++ b/push/pom.xml @@ -27,10 +27,6 @@ hertzbeat-push ${project.artifactId} - - 3.2.0 - 3.3.0 - diff --git a/remoting/pom.xml b/remoting/pom.xml index eeda5bbd3a1..4ecbc815861 100644 --- a/remoting/pom.xml +++ b/remoting/pom.xml @@ -27,10 +27,6 @@ hertzbeat-remoting ${project.artifactId} - - 3.2.0 - 3.3.0 - diff --git a/warehouse/pom.xml b/warehouse/pom.xml index 0db9386496d..c0303aa7732 100644 --- a/warehouse/pom.xml +++ b/warehouse/pom.xml @@ -23,15 +23,6 @@ org.apache.hertzbeat 2.0-SNAPSHOT - - 1.0 - 0.13.3 - 2.23 - 3.0.5 - 3.0.0 - 0.7.3 - 8.0.33 - 4.0.0 hertzbeat-warehouse diff --git a/web-app/src/app/routes/monitor/monitor-data-chart/monitor-data-chart.component.html b/web-app/src/app/routes/monitor/monitor-data-chart/monitor-data-chart.component.html index e744e7afaa9..8f1c4cb7fa6 100644 --- a/web-app/src/app/routes/monitor/monitor-data-chart/monitor-data-chart.component.html +++ b/web-app/src/app/routes/monitor/monitor-data-chart/monitor-data-chart.component.html @@ -17,8 +17,7 @@ ~ under the License. --> -
- +
= 5) { - this.cardWidth = this.cardWidth + this.cardWidth; - } this.lineHistoryTheme.series = []; let valueKeyArr = Object.keys(values); for (let index = 0; index < valueKeyArr.length; index++) { diff --git a/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.html b/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.html index 05f4348eb1f..b8973666912 100644 --- a/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.html +++ b/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.html @@ -16,153 +16,160 @@ ~ specific language governing permissions and limitations ~ under the License. --> -
- -
-
-

ID

-

{{ monitorId }}

-
-
-

{{ 'monitors.detail.name' | i18n }}

-

{{ monitor.name }}

-
-
-

HOST

-

{{ monitor.host }}

-
-
-

{{ 'monitors.detail.port' | i18n }}

-

{{ port }}

-
-
-

{{ 'monitors.detail.description' | i18n }}

-

{{ monitor.description }}

-
-
-

{{ 'monitors.detail.status' | i18n }}

-
- - - {{ 'monitor.status.paused' | i18n }} - - - - {{ 'monitor.status.up' | i18n }} - - - - {{ 'monitor.status.down' | i18n }} - + + + + + +
+
+

ID

+

{{ monitorId }}

+
+
+

{{ 'monitors.detail.name' | i18n }}

+

{{ monitor.name }}

+
+
+

HOST

+

{{ monitor.host }}

+
+
+

{{ 'monitors.detail.port' | i18n }}

+

{{ port }}

+
+
+

{{ 'monitors.detail.description' | i18n }}

+

{{ monitor.description }}

+
+
+

{{ 'monitors.detail.status' | i18n }}

+
+ + + {{ 'monitor.status.paused' | i18n }} + + + + {{ 'monitor.status.up' | i18n }} + + + + {{ 'monitor.status.down' | i18n }} + +
+
+
+

{{ 'monitor.intervals' | i18n }}

+

{{ monitor.intervals }}s

+
+
+

{{ 'common.new-time' | i18n }}

+

{{ monitor.gmtCreate | date : 'YYYY-MM-dd HH:mm:ss' }}

+
+
+

{{ 'common.edit-time' | i18n }}

+

{{ monitor.gmtUpdate | date : 'YYYY-MM-dd HH:mm:ss' }}

-
-

{{ 'monitor.intervals' | i18n }}

-

{{ monitor.intervals }}s

-
-
-

{{ 'common.new-time' | i18n }}

-

{{ monitor.gmtCreate | date : 'YYYY-MM-dd HH:mm:ss' }}

-
-
-

{{ 'common.edit-time' | i18n }}

-

{{ monitor.gmtUpdate | date : 'YYYY-MM-dd HH:mm:ss' }}

-
-
- - - - - {{ 'monitor.app.' + app + '.metrics.' + metrics + '.metric.' + field.name | i18nElse : field.name }} - - - - - - - {{ value.origin }} - {{ 'monitors.detail.value.null' | i18n }} - {{ fields[i].unit }} - - - - - - - - {{ 'common.name' | i18n }} - {{ 'common.value' | i18n }} - - - - - - {{ 'monitor.app.' + app + '.metrics.' + metrics + '.metric.' + field.name | i18nElse : field.name }} - - {{ rowValues[i].origin }} - {{ 'monitors.detail.value.null' | i18n }} - {{ field.unit }} - - - - - + + + + + {{ 'monitor.app.' + app + '.metrics.' + metrics + '.metric.' + field.name | i18nElse : field.name }} + + + + + + + + + {{ value.origin }} + {{ 'monitors.detail.value.null' | i18n }} + {{ fields[i].unit }} + + + + + + + + + {{ 'common.name' | i18n }} + {{ 'common.value' | i18n }} + + + + + + {{ 'monitor.app.' + app + '.metrics.' + metrics + '.metric.' + field.name | i18nElse : field.name }} + + {{ rowValues[i].origin }} + {{ 'monitors.detail.value.null' | i18n }} + {{ field.unit }} + + + + + +

@@ -175,10 +182,41 @@ -

- - - {{ 'monitors.collect.time' | i18n }}: {{ time | _date : 'HH:mm:ss' }} - +
+
+ + + {{ 'monitors.collect.time' | i18n }}: {{ time | _date : 'HH:mm:ss' }} + +
+
+ +
+
+ + + +
+ +
+
+ + + {{ ('monitors.collect.time.tip' | i18n) + ': ' + (time | _date : 'yyyy-MM-dd HH:mm:ss') }} + +
+
+
+ + + diff --git a/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.less b/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.less index e21d7f68cac..5f1d96d10e5 100644 --- a/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.less +++ b/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.less @@ -14,4 +14,7 @@ p { .ant-table-body { overflow-y: auto!important; } + .ant-card { + margin-bottom: inherit; + } } diff --git a/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.ts b/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.ts index 11582d1d87d..a2a66783670 100644 --- a/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.ts +++ b/web-app/src/app/routes/monitor/monitor-data-table/monitor-data-table.component.ts @@ -17,7 +17,7 @@ * under the License. */ -import { AfterViewInit, ChangeDetectorRef, Component, ElementRef, Input, OnInit, ViewChild } from '@angular/core'; +import { Component, Input, OnInit } from '@angular/core'; import { NzNotificationService } from 'ng-zorro-antd/notification'; import { finalize } from 'rxjs/operators'; @@ -28,7 +28,7 @@ import { MonitorService } from '../../../service/monitor.service'; templateUrl: './monitor-data-table.component.html', styleUrls: ['./monitor-data-table.component.less'] }) -export class MonitorDataTableComponent implements OnInit, AfterViewInit { +export class MonitorDataTableComponent implements OnInit { @Input() get monitorId(): number { return this._monitorId; @@ -53,8 +53,7 @@ export class MonitorDataTableComponent implements OnInit, AfterViewInit { @Input() height: string = '100%'; - @ViewChild('targetElement', { static: false }) cardElement!: ElementRef; - + showModal!: boolean; time!: any; fields!: any[]; valueRows!: any[]; @@ -62,18 +61,8 @@ export class MonitorDataTableComponent implements OnInit, AfterViewInit { isTable: boolean = true; scrollY: string = '100%'; loading: boolean = false; - cardWidth: number = 300; - constructor(private monitorSvc: MonitorService, private notifySvc: NzNotificationService, private cdr: ChangeDetectorRef) {} - - ngAfterViewInit() { - if (this.cardElement.nativeElement) { - const grandparentElement = this.cardElement.nativeElement.parentElement.parentElement; - const grandparentWidth = grandparentElement.clientWidth; - this.cardWidth = grandparentWidth / 2 - 4; - this.cdr.detectChanges(); - } - } + constructor(private monitorSvc: MonitorService, private notifySvc: NzNotificationService) {} ngOnInit(): void { this.scrollY = `calc(${this.height} - 130px)`; @@ -92,25 +81,9 @@ export class MonitorDataTableComponent implements OnInit, AfterViewInit { this.time = message.data.time; this.fields = message.data.fields; this.valueRows = message.data.valueRows; - let updateWidth = false; if (this.valueRows.length == 1) { this.isTable = false; this.rowValues = this.valueRows[0].values; - } else { - if (this.fields?.length >= 5) { - updateWidth = true; - } - } - this.valueRows.forEach(row => { - row.values.forEach((value: any) => { - if (value.origin?.length > 60) { - updateWidth = true; - } - }); - }); - if (updateWidth) { - this.cardWidth = this.cardWidth + this.cardWidth; - this.cdr.detectChanges(); } } else if (message.code !== 0) { this.notifySvc.warning(`${this.metrics}:${message.msg}`, ''); diff --git a/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.html b/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.html index 2dcdaa66ee0..7cf402565f0 100755 --- a/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.html +++ b/web-app/src/app/routes/monitor/monitor-detail/monitor-detail.component.html @@ -65,6 +65,7 @@ [app]="app" >
.card { - height: 400px; -} diff --git a/yarn.lock b/yarn.lock deleted file mode 100644 index fb57ccd13af..00000000000 --- a/yarn.lock +++ /dev/null @@ -1,4 +0,0 @@ -# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -# yarn lockfile v1 - -