From 096158fdeb00991efa4f7d6118cb65cfd1e53891 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 13 Aug 2024 09:58:04 +0800 Subject: [PATCH 1/4] [feature]add markdown formatter --- home/docs/advanced/extend-http-default.md | 25 +- .../advanced/extend-http-example-hertzbeat.md | 18 +- .../advanced/extend-http-example-token.md | 15 +- home/docs/advanced/extend-http-jsonpath.md | 28 +- home/docs/advanced/extend-http.md | 19 +- home/docs/advanced/extend-jdbc.md | 54 +- home/docs/advanced/extend-jmx.md | 12 +- home/docs/advanced/extend-ngql.md | 8 +- home/docs/advanced/extend-point.md | 23 +- home/docs/advanced/extend-snmp.md | 11 +- home/docs/advanced/extend-ssh.md | 46 +- home/docs/advanced/extend-telnet.md | 16 +- home/docs/advanced/extend-tutorial.md | 16 +- home/docs/community/become_committer.md | 30 +- home/docs/community/become_pmc_member.md | 30 +- .../community/code-style-and-quality-guide.md | 700 +++++++++--------- home/docs/community/contact.md | 2 +- home/docs/community/contribution.md | 47 +- home/docs/community/development.md | 8 +- home/docs/community/document.md | 29 +- home/docs/community/how-to-release.md | 52 +- home/docs/community/how-to-verify.md | 17 +- home/docs/community/mailing_lists.md | 41 +- home/docs/community/new_committer_process.md | 36 +- home/docs/community/new_pmc_member_process.md | 30 +- home/docs/community/submit-code.md | 68 +- home/docs/download.md | 5 +- home/docs/help/activemq.md | 129 ++-- home/docs/help/airflow.md | 40 +- home/docs/help/alert_console.md | 4 +- home/docs/help/alert_dingtalk.md | 20 +- home/docs/help/alert_discord.md | 8 +- home/docs/help/alert_email.md | 29 +- home/docs/help/alert_enterprise_wechat_app.md | 18 +- home/docs/help/alert_feishu.md | 22 +- home/docs/help/alert_slack.md | 3 +- home/docs/help/alert_telegram.md | 3 +- home/docs/help/alert_threshold.md | 1 + home/docs/help/alert_threshold_expr.md | 64 +- home/docs/help/alert_webhook.md | 46 +- home/docs/help/alert_wework.md | 26 +- home/docs/help/almalinux.md | 43 +- home/docs/help/api.md | 46 +- home/docs/help/centos.md | 102 +-- home/docs/help/clickhouse.md | 142 ++-- home/docs/help/debian.md | 27 +- home/docs/help/dm.md | 54 +- home/docs/help/dns.md | 13 +- home/docs/help/docker.md | 96 ++- home/docs/help/doris_be.md | 171 ++--- home/docs/help/doris_fe.md | 75 +- home/docs/help/dynamic_tp.md | 45 +- home/docs/help/elasticsearch.md | 7 +- home/docs/help/euleros.md | 13 +- home/docs/help/flink.md | 19 +- home/docs/help/freebsd.md | 7 +- home/docs/help/ftp.md | 5 +- home/docs/help/fullsite.md | 41 +- home/docs/help/guide.md | 271 ++++--- home/docs/help/hadoop.md | 13 +- home/docs/help/hbase_master.md | 24 +- home/docs/help/hbase_regionserver.md | 26 +- home/docs/help/hdfs_datanode.md | 55 +- home/docs/help/hdfs_namenode.md | 121 +-- home/docs/help/hive.md | 69 +- home/docs/help/http_sd.md | 26 +- home/docs/help/huawei_switch.md | 107 +-- home/docs/help/hugegraph.md | 235 +++--- home/docs/help/influxdb.md | 77 +- home/docs/help/influxdb_promql.md | 11 +- home/docs/help/iotdb.md | 45 +- home/docs/help/issue.md | 45 +- home/docs/help/jetty.md | 9 +- home/docs/help/jvm.md | 8 +- home/docs/help/kafka.md | 92 ++- home/docs/help/kafka_promql.md | 9 +- home/docs/help/kubernetes.md | 86 +-- home/docs/help/linux.md | 102 +-- home/docs/help/mariadb.md | 65 +- home/docs/help/memcached.md | 9 +- home/docs/help/mongodb.md | 16 +- home/docs/help/mysql.md | 43 +- home/docs/help/nacos.md | 188 ++--- home/docs/help/nebulagraph.md | 9 +- home/docs/help/nebulagraph_cluster.md | 11 +- home/docs/help/nginx.md | 46 +- home/docs/help/ntp.md | 4 +- home/docs/help/openai.md | 10 +- home/docs/help/opengauss.md | 70 +- home/docs/help/opensuse.md | 130 ++-- home/docs/help/oracle.md | 53 +- home/docs/help/ping.md | 29 +- home/docs/help/plugin.md | 5 +- home/docs/help/pop3.md | 12 +- home/docs/help/port.md | 30 +- home/docs/help/postgresql.md | 68 +- home/docs/help/process.md | 45 +- home/docs/help/prometheus.md | 4 +- home/docs/help/pulsar.md | 46 +- home/docs/help/rabbitmq.md | 50 +- home/docs/help/redhat.md | 13 +- home/docs/help/redis.md | 401 +++++----- home/docs/help/rocketmq.md | 7 +- home/docs/help/rockylinux.md | 13 +- home/docs/help/shenyu.md | 103 ++- home/docs/help/smtp.md | 5 +- home/docs/help/spark.md | 19 +- home/docs/help/spring_gateway.md | 70 +- home/docs/help/springboot2.md | 61 +- home/docs/help/springboot3.md | 13 +- home/docs/help/sqlserver.md | 70 +- home/docs/help/ssl_cert.md | 35 +- home/docs/help/tidb.md | 110 +-- home/docs/help/time_expression.md | 41 +- home/docs/help/tomcat.md | 75 +- home/docs/help/ubuntu.md | 102 +-- home/docs/help/udp_port.md | 6 +- home/docs/help/website.md | 35 +- home/docs/help/websocket.md | 5 +- home/docs/help/windows.md | 43 +- home/docs/help/yarn.md | 103 +-- home/docs/help/zookeeper.md | 97 +-- home/docs/introduce.md | 24 +- home/docs/others/design.md | 6 +- home/docs/others/resource.md | 16 +- home/docs/start/account-modify.md | 11 +- home/docs/start/custom-config.md | 10 +- home/docs/start/docker-deploy.md | 95 +-- home/docs/start/greptime-init.md | 32 +- home/docs/start/influxdb-init.md | 54 +- home/docs/start/iotdb-init.md | 7 +- home/docs/start/mysql-change.md | 33 +- home/docs/start/package-deploy.md | 31 +- home/docs/start/postgresql-change.md | 15 +- home/docs/start/quickstart.md | 10 +- home/docs/start/rainbond-deploy.md | 2 +- home/docs/start/sslcert-practice.md | 13 - home/docs/start/tdengine-init.md | 88 ++- home/docs/start/upgrade.md | 17 +- home/docs/start/victoria-metrics-init.md | 32 +- home/docs/template.md | 24 +- pom.xml | 32 +- 142 files changed, 3531 insertions(+), 3527 deletions(-) diff --git a/home/docs/advanced/extend-http-default.md b/home/docs/advanced/extend-http-default.md index cb8cec5b7aa..9ccb0e9454b 100644 --- a/home/docs/advanced/extend-http-default.md +++ b/home/docs/advanced/extend-http-default.md @@ -4,14 +4,16 @@ 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. +> 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** +**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. +### HertzBeat data format specification + +Note⚠️ The response data is JSON format. Single layer format ：key-value + ```json { "metricName1": "metricValue", @@ -20,7 +22,9 @@ Single layer format ：key-value "metricName4": "metricValue" } ``` + Multilayer format：Set key value in the array + ```json [ { @@ -37,9 +41,11 @@ Multilayer format：Set key value in the array } ] ``` + eg： -Query the CPU information of the custom system. The exposed interface is `/metrics/cpu`. We need `hostname,core,useage` Metric. -If there is only one virtual machine, its single-layer format is : +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", @@ -49,7 +55,9 @@ If there is only one virtual machine, its single-layer format is : "runningTime": 100 } ``` -If there are multiple virtual machines, the multilayer format is: : + +If there are multiple virtual machines, the multilayer format is: : + ```json [ { @@ -76,7 +84,7 @@ If there are multiple virtual machines, the multilayer format is: : ] ``` -**The corresponding monitoring template yml can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -146,3 +154,4 @@ metrics: # Hertzbeat default parsing is used here parseType: default ``` + diff --git a/home/docs/advanced/extend-http-example-hertzbeat.md b/home/docs/advanced/extend-http-example-hertzbeat.md index 4c65e29b8da..93a5c1e2dce 100644 --- a/home/docs/advanced/extend-http-example-hertzbeat.md +++ b/home/docs/advanced/extend-http-example-hertzbeat.md @@ -8,12 +8,10 @@ Through this tutorial, we describe step by step how to add a monitoring type bas 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, @@ -22,6 +20,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz } ``` + 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: @@ -63,16 +62,13 @@ As above, usually our background API interface will design such a general return **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 @@ -200,38 +196,30 @@ metrics: **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. +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** diff --git a/home/docs/advanced/extend-http-example-token.md b/home/docs/advanced/extend-http-example-token.md index b9bbb61e72d..7881b048357 100644 --- a/home/docs/advanced/extend-http-example-token.md +++ b/home/docs/advanced/extend-http-example-token.md @@ -22,6 +22,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz "identifier": "admin" } ``` + **The response structure data is as follows**: ```json @@ -40,11 +41,9 @@ Before reading this tutorial, we hope that you are familiar with how to customiz **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 @@ -214,15 +213,12 @@ metrics: ![](/img/docs/advanced/extend-http-example-5.png) - ** After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page. ** ![](/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** @@ -334,8 +330,7 @@ metrics: # 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 @@ -385,12 +380,12 @@ metrics: > 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. +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** diff --git a/home/docs/advanced/extend-http-jsonpath.md b/home/docs/advanced/extend-http-jsonpath.md index 772c96d20d3..86a49c06756 100644 --- a/home/docs/advanced/extend-http-jsonpath.md +++ b/home/docs/advanced/extend-http-jsonpath.md @@ -3,16 +3,18 @@ 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. +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** -**Use the JsonPath script to parse the response data into data that conforms to the data structure rules specified by HertzBeat** +#### JsonPath Operator -#### JsonPath Operator -[JSONPath online verification](https://www.jsonpath.cn) +[JSONPath online verification](https://www.jsonpath.cn) -| JSONPATH | Help description | +| JSONPATH | Help description | |------------------|----------------------------------------------------------------------------------------| | $ | Root object or element | | @ | Current object or element | @@ -25,8 +27,10 @@ Note⚠️ The response data is JSON format. | ?() | Filter (script) expression | | () | Script Expression | -#### HertzBeat data format specification +#### HertzBeat data format specification + Single layer format ：key-value + ```json { "metricName1": "metricValue", @@ -35,7 +39,9 @@ Single layer format ：key-value "metricName4": "metricValue" } ``` + Multilayer format：Set key value in the array + ```json [ { @@ -56,7 +62,8 @@ Multilayer format：Set key value in the array #### Example Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. -The raw data returned by the interface is as follows： +The raw data returned by the interface is as follows： + ```json { "firstName": "John", @@ -80,7 +87,8 @@ The raw data returned by the interface is as follows： } ``` -We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： +We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： + ```json [ { @@ -93,9 +101,10 @@ We use the jsonpath script to parse, and the corresponding script is: `$.number[ } ] ``` + This data structure conforms to the data format specification of HertzBeat, and the Metric `type,num` is successfully extracted. -**The corresponding monitoring template yml can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -163,3 +172,4 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` + diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 242b63e8cf0..bab8800e7a1 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -1,35 +1,33 @@ --- id: extend-http title: HTTP Protocol Custom Monitoring -sidebar_label: 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 +> 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 +### 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. +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) - +**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 +### 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. +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. @@ -205,3 +203,4 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` + diff --git a/home/docs/advanced/extend-jdbc.md b/home/docs/advanced/extend-jdbc.md index 3527ba60d5d..ec42f84f642 100644 --- a/home/docs/advanced/extend-jdbc.md +++ b/home/docs/advanced/extend-jdbc.md @@ -1,68 +1,73 @@ --- id: extend-jdbc title: JDBC Protocol Custom Monitoring -sidebar_label: 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**】 +> 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 +### 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. +#### **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. +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. + +> 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. +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. + +> 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： +SQL response data： -| key | value | -|---------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +| 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 +### 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. - +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 @@ -236,3 +241,4 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` + diff --git a/home/docs/advanced/extend-jmx.md b/home/docs/advanced/extend-jmx.md index 5284118f8a7..2f9ba992f63 100644 --- a/home/docs/advanced/extend-jmx.md +++ b/home/docs/advanced/extend-jmx.md @@ -1,12 +1,14 @@ --- id: extend-jmx title: JMX Protocol Custom Monitoring -sidebar_label: 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. @@ -15,25 +17,24 @@ It can be seen from the process that we define a monitoring type of JMX protocol 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 +### 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 @@ -191,3 +192,4 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` + diff --git a/home/docs/advanced/extend-ngql.md b/home/docs/advanced/extend-ngql.md index c07c5ae8ca0..2047e1d1cf5 100644 --- a/home/docs/advanced/extend-ngql.md +++ b/home/docs/advanced/extend-ngql.md @@ -22,9 +22,9 @@ Mapping the fields returned by NGQL queries to the metrics we need allows us to For example: - online_meta_count#SHOW HOSTS META#Status#ONLINE - Counts the number of rows returned by `SHOW HOSTS META` where Status equals ONLINE. +Counts the number of rows returned by `SHOW HOSTS META` where Status equals ONLINE. - online_meta_count#SHOW HOSTS META## - Counts the number of rows returned by `SHOW HOSTS META`. +Counts the number of rows returned by `SHOW HOSTS META`. #### **oneRow** @@ -68,12 +68,13 @@ Notes: ![HertzBeat Page](/img/docs/advanced/extend-point-1.png) ------- + Configuration usages of the monitoring templates yml are detailed below. ### Monitoring Template YML > We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> Monitoring template is used to define the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information, etc. +> Monitoring template is used to define the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information, etc. eg: Customize a monitoring type named example_ngql, which collects metric data using NGQL. @@ -165,3 +166,4 @@ metrics: - match (v:tag2) return "tag2" as name ,count(v) as cnt timeout: ^_^timeout^_^ ``` + diff --git a/home/docs/advanced/extend-point.md b/home/docs/advanced/extend-point.md index eba1811e4fc..314e3f1affa 100644 --- a/home/docs/advanced/extend-point.md +++ b/home/docs/advanced/extend-point.md @@ -1,31 +1,29 @@ --- id: extend-point title: Custom Monitoring -sidebar_label: 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 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. -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** +### 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 +### 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 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** - +**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 @@ -132,3 +130,4 @@ metrics: parseType: website ``` + diff --git a/home/docs/advanced/extend-snmp.md b/home/docs/advanced/extend-snmp.md index c97aea1f766..b3bb9173c87 100644 --- a/home/docs/advanced/extend-snmp.md +++ b/home/docs/advanced/extend-snmp.md @@ -1,23 +1,22 @@ --- id: extend-snmp title: SNMP Protocol Custom Monitoring -sidebar_label: 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** @@ -25,18 +24,17 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p ![](/img/docs/advanced/extend-point-1.png) ------- + Configuration usages of the monitoring templates yml are detailed below. ### 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 @@ -171,3 +169,4 @@ metrics: processes: 1.3.6.1.2.1.25.1.6.0 location: 1.3.6.1.2.1.1.6.0 ``` + diff --git a/home/docs/advanced/extend-ssh.md b/home/docs/advanced/extend-ssh.md index 772ee315207..bf960376179 100644 --- a/home/docs/advanced/extend-ssh.md +++ b/home/docs/advanced/extend-ssh.md @@ -1,21 +1,25 @@ --- id: extend-ssh title: SSH Protocol Custom Monitoring -sidebar_label: 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**】 +> 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 +### 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. +#### **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 @@ -23,31 +27,37 @@ 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： +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` +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 +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. + +> 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： +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： +Console response is： + ```shell total used free buff_cache available 7962 4066 331 3564 3592 @@ -60,18 +70,17 @@ Here the Metric field and the response data can be mapped into collected data on **HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** ------- + Configuration usages of the monitoring templates yml are detailed below. ### 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 @@ -203,3 +212,4 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` + diff --git a/home/docs/advanced/extend-telnet.md b/home/docs/advanced/extend-telnet.md index 9aa8eac92f1..7b45c5aab32 100644 --- a/home/docs/advanced/extend-telnet.md +++ b/home/docs/advanced/extend-telnet.md @@ -1,29 +1,31 @@ --- id: extend-telnet title: Telnet Protocol Custom Monitoring -sidebar_label: Telnet Protocol Custom Monitoring +sidebar_label: Telnet 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 Telnet to customize Metric monitoring. > Telnet protocol custom monitoring allows us to easily monitor and collect the Linux Metrics we want by writing sh command script. -### Telnet protocol collection process +### Telnet 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 Telnet protocol. We need to configure Telnet request parameters, configure which Metrics to obtain, and configure query script statements. ### Data parsing method -By configuring the metrics `field`, `aliasFields` the `Telnet` protocol of the monitoring template YML to capture the data specified by the peer and parse the mapping. +By configuring the metrics `field`, `aliasFields` the `Telnet` protocol of the monitoring template YML to capture the data specified by the peer and parse the mapping. -### Custom Steps +### 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. + +Configuration usages of the monitoring templates yml are detailed below. ### Monitoring Templates YML @@ -32,7 +34,6 @@ Configuration usages of the monitoring templates yml are detailed below. eg：Define a custom monitoring type `app` named `zookeeper` which use the telnet protocol to collect data. - ```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-网络监控等等 @@ -296,3 +297,4 @@ metrics: ``` + diff --git a/home/docs/advanced/extend-tutorial.md b/home/docs/advanced/extend-tutorial.md index 9f21219a29f..f991b5702e8 100644 --- a/home/docs/advanced/extend-tutorial.md +++ b/home/docs/advanced/extend-tutorial.md @@ -8,12 +8,10 @@ Through this tutorial, we describe step by step how to customize and adapt a mon 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, @@ -22,6 +20,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz } ``` + 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: @@ -58,17 +57,14 @@ As above, usually our background API interface will design such a general return **This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** - ### 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** @@ -199,32 +195,24 @@ metrics: **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! diff --git a/home/docs/community/become_committer.md b/home/docs/community/become_committer.md index f2824bdc4ed..382e69fb9bf 100644 --- a/home/docs/community/become_committer.md +++ b/home/docs/community/become_committer.md @@ -5,20 +5,20 @@ sidebar_position: 2 --- ## Become A Committer of Apache HertzBeat @@ -66,6 +66,7 @@ of the main website or HertzBeat's GitHub repositories. - +1 month with solid activity and engagement. ### Quality of contributions + - A solid general understanding of the project - Well tested, well-designed, following Apache HertzBeat coding standards, and simple patches. @@ -82,3 +83,4 @@ of the main website or HertzBeat's GitHub repositories. - Be involved in the design road map discussions with a professional and diplomatic approach even if there is a disagreement - Promoting the project by writing articles or holding events + diff --git a/home/docs/community/become_pmc_member.md b/home/docs/community/become_pmc_member.md index cf48cbe7c82..cd9dff4e02a 100644 --- a/home/docs/community/become_pmc_member.md +++ b/home/docs/community/become_pmc_member.md @@ -5,20 +5,20 @@ sidebar_position: 3 --- ## Become A PMC member of Apache HertzBeat @@ -66,6 +66,7 @@ of the main website or HertzBeat's GitHub repositories. - +3 month with solid activity and engagement. ### Quality of contributions + - A solid general understanding of the project - Well tested, well-designed, following Apache HertzBeat coding standards, and simple patches. @@ -82,3 +83,4 @@ of the main website or HertzBeat's GitHub repositories. - Be involved in the design road map discussions with a professional and diplomatic approach even if there is a disagreement - Promoting the project by writing articles or holding events + diff --git a/home/docs/community/code-style-and-quality-guide.md b/home/docs/community/code-style-and-quality-guide.md index 755a98f3fd7..c86438a577e 100644 --- a/home/docs/community/code-style-and-quality-guide.md +++ b/home/docs/community/code-style-and-quality-guide.md @@ -5,39 +5,36 @@ sidebar_position: 3 --- - ## 1 Pull Requests & Changes Rule 1. `ISSUE`/`PR`(pull request) driving and naming - - After creating a new `PR`, you need to associate the existing corresponding `ISSUE` at the Github Development button on the `PR` page (if there is no corresponding ISSUE, it is recommended to create a new corresponding ISSUE). + - After creating a new `PR`, you need to associate the existing corresponding `ISSUE` at the Github Development button on the `PR` page (if there is no corresponding ISSUE, it is recommended to create a new corresponding ISSUE). - - Title naming format - `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + - Title naming format + `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` 2. Description - - Please fill in the `PR` template to describe the contribution. So that the reviewer can understand the problem and solution from the description, rather than just from the code. - - Check the CheckList - + - Please fill in the `PR` template to describe the contribution. So that the reviewer can understand the problem and solution from the description, rather than just from the code. + - Check the CheckList 3. It's recommended that `PR` should be arranged changes such as `cleanup`, `Refactor`, `improve`, and `feature` into separated `PRs`/`Commits`. - 4. Commit message(English, lowercase, no special characters) The commit of messages should follow a pattern similar to the `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` @@ -50,11 +47,11 @@ sidebar_position: 3 3. Set **Checkstyle version** to **10.14.2**. 4. Set **Scan scope** to **Only Java sources (including tests)**. 5. Click **+** button in the **Configuration** section to open a dialog to choose the checkstyle config file. - 1. Enter a **Description**. For example, hertzbeat. - 2. Select **Use a local checkstyle file**. - 3. Set **File** to **script/checkstyle/checkstyle.xml**. - 4. Select **Store relative to project location**. - 5. Click **Next** → **Next** → **Finish**. + 1. Enter a **Description**. For example, hertzbeat. + 2. Select **Use a local checkstyle file**. + 3. Set **File** to **script/checkstyle/checkstyle.xml**. + 4. Select **Store relative to project location**. + 5. Click **Next** → **Next** → **Finish**. 6. Activate the configuration you just added by toggling the corresponding box. 7. Click **OK**. @@ -69,96 +66,94 @@ sidebar_position: 3 ### 3.1 Naming Style 1. Prioritize selecting nouns for variable naming, it's easier to distinguish between `variables` or `methods`. + ```java - Cache publicKeyCache; + Cache publicKeyCache; ``` - 2. Pinyin abbreviations are prohibited for variables (excluding nouns such as place names), such as chengdu. - 3. It is recommended to end variable names with a `type`. For variables of type `Collection/List`, take `xxxx` (plural representing multiple elements) or end with `xxxList` (specific type). For variables of type `map`, describe the `key` and `value` clearly: + ```java - Map idUserMap; - Map userIdNameMap; + Map idUserMap; + Map userIdNameMap; ``` - 4. That can intuitively know the type and meaning of the variable through its name. Method names should start with a verb first as follows: + ```java - void computeVcores(Object parameter1); + void computeVcores(Object parameter1); ``` + > Note: It is not necessary to strictly follow this rule in the `Builder` tool class. - ### 3.2 Constant Variables Definition -1. Redundant strings should be extracted as constants - >If a constant has been hardcoded twice or more times, please directly extract it as a constant and change the corresponding reference. - In generally, constants in `log` can be ignored to extract. - - - Negative demo: - - ```java - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put("status", "success"); - resp.put("code", ResponseCode.CODE_SUCCESS); - resp.put("data", data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put("status", "error"); - resp.put("code", ResponseCode.CODE_FAIL); - resp.put("data", null); - return resp; - } - ``` - - - Positive demo: - - > Strings are extracted as constant references. - - ```java - public static final String STATUS = "status"; - public static final String CODE = "code"; - public static final String DATA = "data"; - - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "success"); - resp.put(CODE, ResponseCode.CODE_SUCCESS); - resp.put(DATA, data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "error"); - resp.put(CODE, ResponseCode.CODE_FAIL); - resp.put(DATA, null); - return resp; - } - ``` +1. Redundant strings should be extracted as constants + + > If a constant has been hardcoded twice or more times, please directly extract it as a constant and change the corresponding reference. + > In generally, constants in `log` can be ignored to extract. + + - Negative demo: + + ```java + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put("status", "success"); + resp.put("code", ResponseCode.CODE_SUCCESS); + resp.put("data", data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put("status", "error"); + resp.put("code", ResponseCode.CODE_FAIL); + resp.put("data", null); + return resp; + } + ``` + - Positive demo: + + > Strings are extracted as constant references. + + ```java + public static final String STATUS = "status"; + public static final String CODE = "code"; + public static final String DATA = "data"; + + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "success"); + resp.put(CODE, ResponseCode.CODE_SUCCESS); + resp.put(DATA, data); + return resp; + } + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "error"); + resp.put(CODE, ResponseCode.CODE_FAIL); + resp.put(DATA, null); + return resp; + } + ``` 2. Ensure code readability and intuitiveness - - The string in the `annotation` symbol doesn't need to be extracted as constant. +- The string in the `annotation` symbol doesn't need to be extracted as constant. - - The referenced `package` or `resource` name doesn't need to be extracted as constant. +- The referenced `package` or `resource` name doesn't need to be extracted as constant. 3. Variables that have not been reassigned must also be declared as final types. -4. About the arrangement order of `constant/variable` lines +4. About the arrangement order of `constant/variable` lines Sort the variable lines in the class in the order of 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` 2. `public static v`, `static v`,`protected static v`, `private static v` 3. `public v`, `v`, `protected v`, `private v` - ### 3.3 Methods Rule 1. Sort the methods in the class in the order of `public`, `protected`, `private` @@ -174,9 +169,9 @@ sidebar_position: 3 3. If there are too many lines of code in the method, please have a try on using multiple sub methods at appropriate points to segment the method body. Generally speaking, it needs to adhere to the following principles: - - Convenient testing - - Good semantics - - Easy to read + - Convenient testing + - Good semantics + - Easy to read In addition, it is also necessary to consider whether the splitting is reasonable in terms of components, logic, abstraction, and other aspects in the scenario. @@ -185,35 +180,31 @@ sidebar_position: 3 ### 3.4 Collection Rule 1. For `collection` returned values, unless there are special `concurrent` (such as thread safety), always return the `interface`, such as: - - - returns List if use `ArrayList` - - returns Map if use `HashMap` - - returns Set if use `HashSet` - + - returns List if use `ArrayList` + - returns Map if use `HashMap` + - returns Set if use `HashSet` 2. If there are multiple threads, the following declaration or returned types can be used: - ```java - private CurrentHashMap map; - public CurrentHashMap funName(); - ``` +```java +private CurrentHashMap map; +public CurrentHashMap funName(); +``` 3. Use `isEmpty()` instead of `length() == 0` or `size() == 0` + - Negative demo： - - Negative demo： - - ```java - if (pathPart.length() == 0) { - return; - } - ``` - - - Positive demo： + ```java + if (pathPart.length() == 0) { + return; + } + ``` + - Positive demo： - ```java - if (pathPart.isEmpty()) { - return; - } - ``` + ```java + if (pathPart.isEmpty()) { + return; + } + ``` ### 3.5 Concurrent Processing @@ -226,9 +217,8 @@ sidebar_position: 3 ### 3.6 Control/Condition Statements 1. Avoid unreasonable `condition/control` branches order leads to: - - - Multiple code line `depths` of `n+1` - - Redundant lines + - Multiple code line `depths` of `n+1` + - Redundant lines Generally speaking, if a method's code line depth exceeds `2+ Tabs` due to continuous nested `if... else..`, it should be considered to try - `merging branches`, @@ -237,77 +227,85 @@ Generally speaking, if a method's code line depth exceeds `2+ Tabs` due to conti to reduce code line depth and improve readability like follows: - Union or merge the logic into the next level calling - - Negative demo: - ```java - if (isInsert) { - save(platform); - } else { - updateById(platform); - } - ``` - - Positive demo: - ```java - saveOrUpdate(platform); - ``` +- Negative demo: + +```java +if (isInsert) { +save(platform); +} else { +updateById(platform); +} +``` + +- Positive demo: + +```java +saveOrUpdate(platform); +``` + - Merge the conditions - - Negative demo: - ```java - if (expression1) { - if(expression2) { - ...... - } - } - ``` - - Positive demo: - ```java - if (expression1 && expression2) { - ...... - } - ``` +- Negative demo: + +```java +if (expression1) { +if(expression2) { +...... +} +} + +``` + +- Positive demo: + + ```java + if (expression1 && expression2) { + ...... + } + ``` - Reverse the condition - - Negative demo: - - ```java - public void doSomething() { - // Ignored more deeper block lines - // ..... - if (condition1) { - ... - } else { - ... - } - } - ``` - - - Positive demo: - - ```java - public void doSomething() { - // Ignored more deeper block lines - // ..... - if (!condition1) { - ... - return; - } - // ... - } - ``` +- Negative demo: + + ```java + public void doSomething() { + // Ignored more deeper block lines + // ..... + if (condition1) { + ... + } else { + ... + } + } + ``` +- Positive demo: + + ```java + public void doSomething() { + // Ignored more deeper block lines + // ..... + if (!condition1) { + ... + return; + } + // ... + } + ``` - Using a single variable or method to reduce the complex conditional expression - - Negative demo: - ```java - if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { - ... - } - ``` - - - Positive demo: - ```java - if (containsSqlServer(dbType)) { - .... - } - //..... - // definition of the containsSqlServer - ``` +- Negative demo: + + ```java + if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { + ... + } + ``` +- Positive demo: + + ```java + if (containsSqlServer(dbType)) { + .... + } + //..... + // definition of the containsSqlServer + ``` > Using `sonarlint` and `better highlights` to check code depth looks like good in the future. @@ -315,22 +313,22 @@ to reduce code line depth and improve readability like follows: 1. Method lacks comments: - - `When`: When can the method be called - - `How`: How to use this method and how to pass parameters, etc. - - `What`: What functions does this method achieve - - `Note`: What should developers pay attention to when calling this method +- `When`: When can the method be called +- `How`: How to use this method and how to pass parameters, etc. +- `What`: What functions does this method achieve +- `Note`: What should developers pay attention to when calling this method 2. Missing necessary class header description comments. - Add `What`, `Note`, etc. like mentioned in the `1`. +Add `What`, `Note`, etc. like mentioned in the `1`. 3. The method declaration in the interface must be annotated. - - If the semantics of the implementation and the annotation content at the interface declaration are inconsistent, the specific implementation method also needs to be rewritten with annotations. +- If the semantics of the implementation and the annotation content at the interface declaration are inconsistent, the specific implementation method also needs to be rewritten with annotations. - - If the semantics of the method implementation are consistent with the annotation content at the interface declaration, it is not recommended to write annotations to avoid duplicate annotations. +- If the semantics of the method implementation are consistent with the annotation content at the interface declaration, it is not recommended to write annotations to avoid duplicate annotations. -4. The first word in the comment lines need to be capitalized, like `param` lines, `return` lines. +4. The first word in the comment lines need to be capitalized, like `param` lines, `return` lines. If a special reference as a subject does not need to be capitalized, special symbols such as quotation marks need to be noted. ### 3.8 Java Lambdas @@ -338,31 +336,29 @@ to reduce code line depth and improve readability like follows: 1. Prefer `non-capturing` lambdas (lambdas that do not contain references to the outer scope). Capturing lambdas need to create a new object instance for every call. `Non-capturing` lambdas can use the same instance for each invocation. - - Negative demo: +- Negative demo: - ```java - map.computeIfAbsent(key, x -> key.toLowerCase()) - ``` - - - Positive demo: + ```java + map.computeIfAbsent(key, x -> key.toLowerCase()) + ``` +- Positive demo: - ```java - map.computeIfAbsent(key, k -> k.toLowerCase()); - ``` + ```java + map.computeIfAbsent(key, k -> k.toLowerCase()); + ``` 2. Consider method references instead of inline lambdas - - Negative demo: - - ```java - map.computeIfAbsent(key, k-> Loader.load(k)); - ``` +- Negative demo: - - Positive demo: + ```java + map.computeIfAbsent(key, k-> Loader.load(k)); + ``` +- Positive demo: - ```java - map.computeIfAbsent(key, Loader::load); - ``` + ```java + map.computeIfAbsent(key, Loader::load); + ``` ### 3.9 Java Streams @@ -380,186 +376,180 @@ to reduce code line depth and improve readability like follows: 1. Use `StringUtils.isBlank` instead of `StringUtils.isEmpty` - - Negative demo: - - ```java - if (StringUtils.isEmpty(name)) { - return; - } - ``` - - - Positive demo: - - ```java - if (StringUtils.isBlank(name)) { - return; - } - ``` +- Negative demo: + + ```java + if (StringUtils.isEmpty(name)) { + return; + } + ``` +- Positive demo: + + ```java + if (StringUtils.isBlank(name)) { + return; + } + ``` 2. Use `StringUtils.isNotBlank` instead of `StringUtils.isNotEmpty` - - Negative demo: - - ```java - if (StringUtils.isNotEmpty(name)) { - return; - } - ``` - - - Positive demo: - - ```java - if (StringUtils.isNotBlank(name)) { - return; - } - ``` +- Negative demo: + + ```java + if (StringUtils.isNotEmpty(name)) { + return; + } + ``` +- Positive demo: + + ```java + if (StringUtils.isNotBlank(name)) { + return; + } + ``` 3. Use `StringUtils.isAllBlank` instead of `StringUtils.isAllEmpty` - - Negative demo: - - ```java - if (StringUtils.isAllEmpty(name, age)) { - return; - } - ``` - - - Positive demo: - - ```java - if (StringUtils.isAllBlank(name, age)) { - return; - } - ``` +- Negative demo: + + ```java + if (StringUtils.isAllEmpty(name, age)) { + return; + } + ``` +- Positive demo: + + ```java + if (StringUtils.isAllBlank(name, age)) { + return; + } + ``` ### 3.12 `Enum` Class 1. Enumeration value comparison - - Negative demo: - - ```java - if (status.equals(JobStatus.RUNNING)) { - return; - } - ``` - - - Positive demo: - - ```java - if (status == JobStatus.RUNNING) { - return; - } - ``` +- Negative demo: + + ```java + if (status.equals(JobStatus.RUNNING)) { + return; + } + ``` +- Positive demo: + + ```java + if (status == JobStatus.RUNNING) { + return; + } + ``` 2. Enumeration classes do not need to implement Serializable - - Negative demo: - - ```java - public enum JobStatus implements Serializable { - ... - } - ``` - - - Positive demo: - - ```java - public enum JobStatus { - ... - } - ``` +- Negative demo: + + ```java + public enum JobStatus implements Serializable { + ... + } + ``` +- Positive demo: + + ```java + public enum JobStatus { + ... + } + ``` 3. Use `Enum.name()` instead of `Enum.toString()` - - Negative demo: - - ```java - System.out.println(JobStatus.RUNNING.toString()); - ``` - - - Positive demo: - - ```java - System.out.println(JobStatus.RUNNING.name()); - ``` +- Negative demo: + + ```java + System.out.println(JobStatus.RUNNING.toString()); + ``` +- Positive demo: + + ```java + System.out.println(JobStatus.RUNNING.name()); + ``` 4. Enumeration class names uniformly use the Enum suffix - - Negative demo: - - ```java - public enum JobStatus { - ... - } - ``` - - - Positive demo: - - ```java - public enum JobStatusEnum { - ... - } - ``` +- Negative demo: + + ```java + public enum JobStatus { + ... + } + ``` +- Positive demo: + + ```java + public enum JobStatusEnum { + ... + } + ``` ### 3.13 `Deprecated` Annotation - - Negative demo: +- Negative demo: - ```java - @deprecated - public void process(String input) { - ... - } - ``` +```java +@deprecated +public void process(String input) { + ... +} +``` - - Positive demo: +- Positive demo: - ```java - @Deprecated - public void process(String input) { - ... - } - ``` +```java +@Deprecated +public void process(String input) { + ... +} +``` ## 4 Log 1. Use `placeholders` for log output: - - Negative demo - ```java - log.info("Deploy cluster request " + deployRequest); - ``` - - Positive demo - ```java - log.info("load plugin:{} to {}", file.getName(), appPlugins); - ``` +- Negative demo -2. Pay attention to the selection of `log level` when printing logs + ```java + log.info("Deploy cluster request " + deployRequest); + ``` +- Positive demo + + ```java + log.info("load plugin:{} to {}", file.getName(), appPlugins); + ``` - When printing the log content, if the actual parameters of the log placeholder are passed, it is necessary to avoid premature evaluation to avoid unnecessary evaluation caused by the log level. +2. Pay attention to the selection of `log level` when printing logs - - Negative demo: +When printing the log content, if the actual parameters of the log placeholder are passed, it is necessary to avoid premature evaluation to avoid unnecessary evaluation caused by the log level. - Assuming the current log level is `INFO`: +- Negative demo: - ```java - // ignored declaration lines. - List userList = getUsersByBatch(1000); - LOG.debug("All users: {}", getAllUserIds(userList)); - ``` + Assuming the current log level is `INFO`: - - Positive demo: + ```java + // ignored declaration lines. + List userList = getUsersByBatch(1000); + LOG.debug("All users: {}", getAllUserIds(userList)); + ``` +- Positive demo: - In this case, we should determine the log level in advance before making actual log calls as follows: + In this case, we should determine the log level in advance before making actual log calls as follows: - ```java - // ignored declaration lines. - List userList = getUsersByBatch(1000); - if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); - } - ``` + ```java + // ignored declaration lines. + List userList = getUsersByBatch(1000); + if (LOG.isDebugEnabled()) { + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + } + ``` ## 5 Testing @@ -568,8 +558,14 @@ to reduce code line depth and improve readability like follows: 2. The implemented interface needs to write the `e2e` test case script under the `e2e` module. ## References + - https://site.mockito.org/ - https://alibaba.github.io/p3c/ - https://rules.sonarsource.com/java/ - https://junit.org/junit5/ - https://streampark.apache.org/ + +``` + +``` + diff --git a/home/docs/community/contact.md b/home/docs/community/contact.md index c5b348343f1..1f1ba55a2cf 100644 --- a/home/docs/community/contact.md +++ b/home/docs/community/contact.md @@ -1,7 +1,7 @@ --- id: contact title: Join discussion -sidebar_label: 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. diff --git a/home/docs/community/contribution.md b/home/docs/community/contribution.md index d433135176d..ef3562258d7 100644 --- a/home/docs/community/contribution.md +++ b/home/docs/community/contribution.md @@ -5,20 +5,20 @@ sidebar_position: 0 --- > We are committed to maintaining a happy community that helps each other, welcome every contributor to join us! @@ -50,7 +50,6 @@ Even small corrections to typos are very welcome :) > To get HertzBeat code running on your development tools, and able to debug with breakpoints. > This is a front-end and back-end separation project. To start the local code, the back-end manager and the front-end web-app must be started separately. - #### Backend start 1. Requires `maven3+`, `java17` and `lombok` environments @@ -88,23 +87,31 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D 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. @@ -137,6 +144,7 @@ git pull upstream master ``` ### HertzBeat Improvement Proposal (HIP) + If you have major new features(e.g., support metrics push gateway, support logs monitoring), you need to write a design document known as a HertzBeat Improvement Proposal (HIP). Before starting to write a HIP, make sure you follow the process [here](https://github.com/apache/hertzbeat/tree/master/hip). ### How to become a Committer? @@ -152,14 +160,15 @@ Add WeChat account `tan-cloud` to pull you into the WeChat group. ## 🥐 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. +> - **[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. +> - **[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. +> - **[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. +> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** Provide web ui. > Angular Web UI. ![hertzBeat](/img/docs/hertzbeat-arch.png) diff --git a/home/docs/community/development.md b/home/docs/community/development.md index 6bc9544a900..549084ce516 100644 --- a/home/docs/community/development.md +++ b/home/docs/community/development.md @@ -1,7 +1,7 @@ --- id: development title: How to Run or Build HertzBeat? -sidebar_label: Development +sidebar_label: Development --- ## Getting HertzBeat code up and running @@ -10,7 +10,6 @@ sidebar_label: Development > This is a front-end and back-end separation project. > To start the local code, the back-end [manager](https://github.com/apache/hertzbeat/tree/master/manager) and the front-end [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) must be started separately. - ### Backend start 1. Requires `maven3+`, `java17` and `lombok` environments @@ -37,9 +36,9 @@ sidebar_label: Development 7. Browser access to localhost:4200 to start, default account/password is *admin/hertzbeat* -## Build HertzBeat binary package +## Build HertzBeat binary package -> Requires `maven3+`, `java17`, `node` and `yarn` environments. +> Requires `maven3+`, `java17`, `node` and `yarn` environments. ### Frontend build @@ -53,7 +52,6 @@ sidebar_label: Development 5. Build web-app: `yarn package` - ### Backend build 1. Requires `maven3+`, `java17` environments diff --git a/home/docs/community/document.md b/home/docs/community/document.md index a4f871bb753..e561b3f1b2c 100644 --- a/home/docs/community/document.md +++ b/home/docs/community/document.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- Good documentation is critical for any type of software. Any contribution that can improve the HertzBeat documentation is welcome. @@ -94,4 +94,3 @@ css and other style files are placed in the `src/css` directory > All pages doc can be directly jumped to the corresponding github resource modification page through the 'Edit this page' button at the bottom - diff --git a/home/docs/community/how-to-release.md b/home/docs/community/how-to-release.md index 8ffca0302cb..ed4bdfb636a 100644 --- a/home/docs/community/how-to-release.md +++ b/home/docs/community/how-to-release.md @@ -22,11 +22,11 @@ This release process is operated in the UbuntuOS(Windows,Mac), and the following ## 2. Preparing for release > First summarize the account information to better understand the operation process, will be used many times later. -- apache id: `muchunjin (APACHE LDAP UserName)` -- apache passphrase: `APACHE LDAP Passphrase` -- apache email: `muchunjin@apache.org` -- gpg real name: `muchunjin (Any name can be used, here I set it to the same name as the apache id)` -- gpg key passphrase: `The password set when creating the gpg key, you need to remember this password` +> - apache id: `muchunjin (APACHE LDAP UserName)` +> - apache passphrase: `APACHE LDAP Passphrase` +> - apache email: `muchunjin@apache.org` +> - gpg real name: `muchunjin (Any name can be used, here I set it to the same name as the apache id)` +> - gpg key passphrase: `The password set when creating the gpg key, you need to remember this password` ### 2.1 Key generation @@ -165,11 +165,10 @@ $ (gpg --list-sigs muchunjin@apache.org && gpg --export --armor muchunjin@apache $ svn ci -m "add gpg key for muchunjin" ``` -## 3. Prepare material package & release +## 3. Prepare material package & release #### 3.1 Based on the master branch, create a release-${release_version}-rcx branch, such as release-1.6.0-rc1, And create a tag named v1.6.0-rc1 based on the release-1.6.0-rc1 branch, and set this tag as pre-release. - ```shell git checkout master git checkout -b release-1.6.0-rc1 @@ -292,7 +291,7 @@ apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz: OK #### 3.7 Publish the dev directory of the Apache SVN material package -- Clone the dev directory +- Clone the dev directory ```shell # Check out the dev directory of the Apache SVN to the svn/dev directory under dist in the root directory of the Apache HertzBeat project @@ -331,7 +330,6 @@ svn commit -m "release for HertzBeat 1.6.0" > Visit the address https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ in the browser, check if existed the new material package - ## 4. Enter the community voting stage #### 4.1 Send a Community Vote Email @@ -340,7 +338,7 @@ Send a voting email in the community requires at least three `+1` and no `-1`. > `Send to`: dev@hertzbeat.apache.org
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
-> `Body`: +> `Body`: ``` Hello HertzBeat Community: @@ -403,8 +401,7 @@ Dear HertzBeat community, Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" I'm happy to announce the vote has passed: - - +--- 4 binding +1, from: - cc @@ -412,17 +409,14 @@ I'm happy to announce the vote has passed: 1 non-binding +1, from: - Roc Marshal - - +--- no 0 or -1 votes. Vote thread: https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq - - +--- Thank you to everyone who helped us to verify and vote for this release. We will move to the ASF Incubator voting shortly. - - +--- Best, ChunJin Mu ``` @@ -474,17 +468,14 @@ More detailed checklist please refer: Steps to validate the release， Please refer to: • https://www.apache.org/info/verification.html • https://hertzbeat.apache.org/docs/community/how_to_verify_release - - +--- How to Build: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package - - +--- Thanks, On behalf of Apache HertzBeat (incubating) community - - +--- Best, ChunJin Mu ``` @@ -546,10 +537,9 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http https://github.com/apache/hertzbeat/blob/master/home/docs/download.md https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md - Open the official website address https://hertzbeat.apache.org/docs/download/ to see if there is a new version of the download -> It should be noted that the download link may take effect after an hour, so please pay attention to it. +> It should be noted that the download link may take effect after an hour, so please pay attention to it. #### 4.3 Generate a release on github @@ -560,11 +550,14 @@ You can modify it on the original RC Release without creating a new Release. ::: Then enter Release Title and Describe -- Release Title: +- Release Title: + ``` v1.6.0 ``` + - Describe: + ``` xxx release note: xxx @@ -596,8 +589,7 @@ Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues - Mailing list: dev@hertzbeat.apache.org - - +--- Apache HertzBeat Team Best, @@ -608,4 +600,4 @@ This version release is over. --- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/docs/community/how-to-verify.md b/home/docs/community/how-to-verify.md index 41c3341b59e..38b507149b0 100644 --- a/home/docs/community/how-to-verify.md +++ b/home/docs/community/how-to-verify.md @@ -40,7 +40,6 @@ The package uploaded to dist must include the source code package, and the binar 3. Whether to include the sha512 of the source code package 4. If the binary package is uploaded, also check the contents listed in (2)-(4) - ### 2.2 Check gpg signature First import the publisher's public key. Import KEYS from the svn repository to the local environment. (The person who releases the version does not need to import it again, the person who helps to do the verification needs to import it, and the user name is enough for the person who issued the version) @@ -51,6 +50,7 @@ First import the publisher's public key. Import KEYS from the svn repository to $ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # Download KEYS $ gpg --import KEYS # Import KEYS to local ``` + #### 2.2.2 Trust the public key Trust the KEY used in this version: @@ -123,8 +123,6 @@ check as follows: - [ ] Able to compile correctly - [ ] ..... - - ### 2.5 Check the source package > If the binary/web-binary package is uploaded, check the binary package. @@ -151,7 +149,6 @@ and check as follows: You can refer to this article: [ASF Third Party License Policy](https://apache.org/legal/resolved.html) - ## 3. Email reply If you initiate a posting vote, you can refer to this response example to reply to the email after verification @@ -170,9 +167,9 @@ If you have already voted on dev@hertzbeat.apache.org, you can take it directly //Incubator community voting, only IPMC members have binding binding，PPMC needs to be aware of binding changes Forward my +1 from dev@listhertzbeatnkis (non-binding) Copy my +1 from hertzbeat DEV ML (non-binding) -```` -::: +``` +::: Non-PPMC/Non-IPMC member: @@ -184,7 +181,7 @@ I checked: 3. LICENSE and NOTICE are exist 4. Build successfully on macOS(Big Sur) 5. -```` +``` PPMC/IPMC member: @@ -197,10 +194,8 @@ I checked: 3. LICENSE and NOTICE are exist 4. Build successfully on macOS(Big Sur) 5. -```` - - +``` --- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/docs/community/mailing_lists.md b/home/docs/community/mailing_lists.md index fed6e3928ee..c5ab8df7604 100644 --- a/home/docs/community/mailing_lists.md +++ b/home/docs/community/mailing_lists.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- The [Developer Mailing List](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) is the community-recommended way to communicate and obtain the latest information. @@ -32,18 +32,17 @@ Before you post anything to the mailing lists, be sure that you already **subscr - Use this list for your HertzBeat questions - Used by HertzBeat contributors to discuss development of HertzBeat - -| List Name | Address | Subscribe | Unsubscribe | Archive | -|---------------------|------------------------------|------------------------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------| -| **Developer List** | dev@hertzbeat.apache.org | [subscribe](mailto:dev-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:dev-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | +| List Name | Address | Subscribe | Unsubscribe | Archive | +|--------------------|--------------------------|--------------------------------------------------------|------------------------------------------------------------|------------------------------------------------------------------------| +| **Developer List** | dev@hertzbeat.apache.org | [subscribe](mailto:dev-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:dev-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | ### Notification List - Notifications on changes to the HertzBeat codebase -| List Name | Address | Subscribe | Unsubscribe | Archive | -|-------------------------|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------| -| **Notification List** | notifications@hertzbeat.apache.org | [subscribe](mailto:notifications-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | +| List Name | Address | Subscribe | Unsubscribe | Archive | +|-----------------------|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------| +| **Notification List** | notifications@hertzbeat.apache.org | [subscribe](mailto:notifications-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | ## Steps for Subscription diff --git a/home/docs/community/new_committer_process.md b/home/docs/community/new_committer_process.md index b72ec6e30b7..0801f579000 100644 --- a/home/docs/community/new_committer_process.md +++ b/home/docs/community/new_committer_process.md @@ -5,20 +5,20 @@ sidebar_position: 4 --- [Apache New Committer Guideline](https://community.apache.org/newcommitter.html#new-committer-process) @@ -47,10 +47,9 @@ sidebar_position: 4 see **Committer Account Creation** - - Wait until root says it is done - - PMC Chair enables svn and other access - - Add committer to the appropriate groups in JIRA and CWiki - + - Wait until root says it is done + - PMC Chair enables svn and other access + - Add committer to the appropriate groups in JIRA and CWiki - Notify the committer of completion see **Committer Done Template** @@ -243,3 +242,4 @@ you can now help fix that. A PPMC member will announce your election to the dev list soon. ``` + diff --git a/home/docs/community/new_pmc_member_process.md b/home/docs/community/new_pmc_member_process.md index ebc84b92d67..414dad94a56 100644 --- a/home/docs/community/new_pmc_member_process.md +++ b/home/docs/community/new_pmc_member_process.md @@ -5,20 +5,20 @@ sidebar_position: 5 --- [Apache New Committer Guideline](https://community.apache.org/newcommitter.html#new-committer-process) @@ -81,7 +81,6 @@ ${Work list}[1] Note that, Voting ends one week from today, i.e. [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) [Apache Voting Guidelines](https://community.apache.org/newcommitter.html) - ### Close Vote Template ```text @@ -283,3 +282,4 @@ A PPMC member helps manage and guide the direction of the project. Thanks, On behalf of the Apache HertzBeat (incubating) PPMC ``` + diff --git a/home/docs/community/submit-code.md b/home/docs/community/submit-code.md index dfea1601d87..15bfeba545a 100644 --- a/home/docs/community/submit-code.md +++ b/home/docs/community/submit-code.md @@ -5,22 +5,21 @@ sidebar_position: 2 --- - * First from the remote repository fork a copy of the code into your own repository * The remote dev and merge branch is `master`. @@ -28,49 +27,44 @@ sidebar_position: 2 * Clone your repository to your local ```shell - git clone git@github.com:/hertzbeat.git +git clone git@github.com:/hertzbeat.git ``` * Add remote repository address, named upstream ```shell - git remote add upstream git@github.com:apache/hertzbeat.git +git remote add upstream git@github.com:apache/hertzbeat.git ``` * View repository ```shell - git remote -v +git remote -v ``` - > At this time, there will be two repositories: origin (your own repository) and upstream (remote repository) +> At this time, there will be two repositories: origin (your own repository) and upstream (remote repository) * Get/Update remote repository code - ```shell - git fetch upstream - ``` - + ```shell + git fetch upstream + ``` * Synchronize remote repository code to local repository - ```shell - git checkout origin/dev - git merge --no-ff upstream/dev - ``` - + ```shell + git checkout origin/dev + git merge --no-ff upstream/dev + ``` * **⚠️Note that you must create a new branch to develop features `git checkout -b feature-xxx`. It is not recommended to use the master branch for direct development** - * After modifying the code locally, submit it to your own repository: - **Note that the submission information does not contain special characters** - ```shell - git commit -m 'commit content' - git push - ``` + **Note that the submission information does not contain special characters** + ```shell + git commit -m 'commit content' + git push + ``` * Submit changes to the remote repository, you can see a green button "Compare & pull request" on your repository page, click it. - * Select the modified local branch and the branch you want to merge with the past, you need input the message carefully, describe doc is important as code, click "Create pull request". - * Then the community Committers will do CodeReview, and then he will discuss some details (design, implementation, performance, etc.) with you, afterward you can directly update the code in this branch according to the suggestions (no need to create a new PR). When this pr is approved, the commit will be merged into the master branch - * Finally, congratulations, you have become an official contributor to HertzBeat ! You will be added to the contributor wall, you can contact the community to obtain a contributor certificate. + diff --git a/home/docs/download.md b/home/docs/download.md index 827784bea00..4bccd984b70 100644 --- a/home/docs/download.md +++ b/home/docs/download.md @@ -18,12 +18,10 @@ sidebar_label: Download Previous releases of HertzBeat may be affected by security issues, please use the latest one. ::: - -| Version | Date | Download | Release Notes | +| Version | Date | Download | Release Notes | |---------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| | v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | - ## Release Docker Image > Apache HertzBeat provides a docker image for each release. You can pull the image from the [Docker Hub](https://hub.docker.com/r/apache/hertzbeat). @@ -31,7 +29,6 @@ Previous releases of HertzBeat may be affected by security issues, please use th - HertzBeat https://hub.docker.com/r/apache/hertzbeat - HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector - ## All Archived Releases For older releases, please check the [archive](https://archive.apache.org/dist/incubator/hertzbeat/). diff --git a/home/docs/help/activemq.md b/home/docs/help/activemq.md index 52e3090fde2..f24bc37fbbb 100644 --- a/home/docs/help/activemq.md +++ b/home/docs/help/activemq.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] **Use Protocol: JMX** -### Pre-monitoring Operations +### Pre-monitoring Operations > You need to enable the `JMX` service on ActiveMQ, HertzBeat uses the JMX protocol to collect metrics from ActiveMQ. @@ -26,6 +26,7 @@ keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] 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" @@ -36,6 +37,7 @@ 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" @@ -52,7 +54,7 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" ### Configuration parameters -| Parameter name | Parameter help description | +| 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. | @@ -64,82 +66,81 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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 +### Collect Metrics #### metrics: broker -| Metric Name | Unit | Description | +| Metric Name | Unit | Description | |-------------------------|------|-----------------------------------------------------------------------| -| BrokerName | None | The name of the broker. | -| BrokerVersion | None | The version of the broker. | -| Uptime | None | Uptime of the broker. | +| 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. | +| 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 | - +| 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 | +| 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 | - +| 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 | +| 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/docs/help/airflow.md b/home/docs/help/airflow.md index 5323ede8110..52367155d89 100644 --- a/home/docs/help/airflow.md +++ b/home/docs/help/airflow.md @@ -9,33 +9,31 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：airflow_health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | -------------------- | -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|------------------| +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | #### 指标集合：airflow_version -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | --------------- | -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------| +| value | 无 | Airflow版本 | +| git_version | 无 | Airflow git版本 | diff --git a/home/docs/help/alert_console.md b/home/docs/help/alert_console.md index e727fec4771..45ab7d791d3 100644 --- a/home/docs/help/alert_console.md +++ b/home/docs/help/alert_console.md @@ -6,13 +6,13 @@ 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. \ No newline at end of file +The default value is the official console address of HertzBeat. diff --git a/home/docs/help/alert_dingtalk.md b/home/docs/help/alert_dingtalk.md index fb63d52aa48..b86ed662940 100644 --- a/home/docs/help/alert_dingtalk.md +++ b/home/docs/help/alert_dingtalk.md @@ -5,15 +5,15 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by DingDing robot. -### Operation steps +### 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. +> 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) +![email](/img/docs/help/alert-notice-8.png) 2. **【Save access_token value of the WebHook address of the robot】** @@ -24,18 +24,18 @@ keywords: [open source monitoring tool, open source alerter, open source DingDin ![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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### DingDing robot common issues -### DingDing robot common issues +1. DingDing group did not receive the robot alarm notification. -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_discord.md b/home/docs/help/alert_discord.md index 8dfdca384fa..7aa565c0acf 100644 --- a/home/docs/help/alert_discord.md +++ b/home/docs/help/alert_discord.md @@ -45,7 +45,6 @@ keywords: [open source monitoring tool, open source alerter, open source Discord ![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]** @@ -58,13 +57,12 @@ keywords: [open source monitoring tool, open source alerter, open source Discord ![email](/img/docs/help/alert-notice-policy.png) +### Discord Bot Notification FAQ -### Discord Bot Notification FAQ - -1. Discord doesn't receive bot alert notifications +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 +> Please check whether the bot is properly authorized by the Discord chat server Other questions can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_email.md b/home/docs/help/alert_email.md index 353ae4673fe..fb6dc7fa571 100644 --- a/home/docs/help/alert_email.md +++ b/home/docs/help/alert_email.md @@ -5,34 +5,35 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by email. -### Operation steps +### Operation steps -1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** +1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** -![email](/img/docs/help/alert-notice-1.png) +![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-2.png) -![email](/img/docs/help/alert-notice-3.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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### Email notification common issues -### Email notification common issues +1. Hertzbeat deployed on its own intranet cannot receive email notifications -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 +> 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 -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. +> 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/docs/help/alert_enterprise_wechat_app.md b/home/docs/help/alert_enterprise_wechat_app.md index f9e072e436a..1d5d41a15bc 100644 --- a/home/docs/help/alert_enterprise_wechat_app.md +++ b/home/docs/help/alert_enterprise_wechat_app.md @@ -5,30 +5,30 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by enterprise WeChat App. -### Operation steps +### 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) +![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】** +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.** +> **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) +![email](/img/docs/help/alert-wechat-3.jpg) +### Enterprise WeChat App common issues -### Enterprise WeChat App common issues +1. Enterprise WeChat App did not receive the alarm notification. -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_feishu.md b/home/docs/help/alert_feishu.md index 56606012021..8f7e9391001 100644 --- a/home/docs/help/alert_feishu.md +++ b/home/docs/help/alert_feishu.md @@ -5,30 +5,30 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by FeiShu robot. -### Operation steps +### 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】** +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` +> 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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### FeiShu robot notification common issues -### FeiShu robot notification common issues +1. FeiShu group did not receive the robot alarm notification. -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. +> 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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_slack.md b/home/docs/help/alert_slack.md index 0de69afa328..c0360e0e4e5 100644 --- a/home/docs/help/alert_slack.md +++ b/home/docs/help/alert_slack.md @@ -25,12 +25,11 @@ Refer to the official website document [Sending messages using Incoming Webhooks ![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 +> Please check whether the slack webhook url are configured correctly, and whether the alarm policy association has been configured Other questions can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_telegram.md b/home/docs/help/alert_telegram.md index 1fbe4f0ae7e..cb60f266778 100644 --- a/home/docs/help/alert_telegram.md +++ b/home/docs/help/alert_telegram.md @@ -54,13 +54,12 @@ Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token ![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 +> UserId should be the UserId of the recipient of the message Other questions can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_threshold.md b/home/docs/help/alert_threshold.md index 0574b1924ba..2619fdbcf6e 100644 --- a/home/docs/help/alert_threshold.md +++ b/home/docs/help/alert_threshold.md @@ -3,6 +3,7 @@ id: alert_threshold title: Threshold Alert Configuration sidebar_label: Threshold Alert Configuration --- + > Configure alert thresholds for monitoring metrics (warning alert, critical alert, emergency alert). The system triggers alerts based on threshold configuration and collected metric data. ## Operational Steps diff --git a/home/docs/help/alert_threshold_expr.md b/home/docs/help/alert_threshold_expr.md index a7a7e6bdbe0..6b8772388e6 100644 --- a/home/docs/help/alert_threshold_expr.md +++ b/home/docs/help/alert_threshold_expr.md @@ -8,40 +8,40 @@ sidebar_label: Threshold Trigger Expression #### Supported Operators in Expressions -| Operator (Visual Configuration) | Operator (Expression Configuration) | Supported Types | Description | -| ------------------------------- | ----------------------------------- | ------------------------- | -------------------------- | -| Equals | equals(str1,str2) | String | Check if strings are equal | -| Not Equals | !equals(str1,str2) | String | Check if strings are not equal | -| Contains | contains(str1,str2) | String | Check if string contains | -| Not Contains | !contains(str1,str2) | String | Check if string does not contain | -| Matches | matches(str1,str2) | String | Check if string matches regex | -| Not Matches | !matches(str1,str2) | String | Check if string does not match regex | -| Exists | exists(obj) | String, Numeric, Time | Check if value exists | -| Not Exists | !exists(obj) | String, Numeric, Time | Check if value does not exist | -| Greater than | obj1 > obj2 | Numeric, Time | Check if value is greater than | -| Less than | obj1 < obj2 | Numeric, Time | Check if value is less than | -| Greater than or Equal to | obj1 >= obj2 | Numeric, Time | Check if value is greater than or equal to | -| Less than or Equal to | obj1 <= obj2 | Numeric, Time | Check if value is less than or equal to | -| Not Equal to | obj1 != obj2 | Numeric, Time | Check if values are not equal | -| Equal to | obj1 == obj2 | Numeric, Time | Check if values are equal | +| Operator (Visual Configuration) | Operator (Expression Configuration) | Supported Types | Description | +|---------------------------------|-------------------------------------|-----------------------|--------------------------------------------| +| Equals | equals(str1,str2) | String | Check if strings are equal | +| Not Equals | !equals(str1,str2) | String | Check if strings are not equal | +| Contains | contains(str1,str2) | String | Check if string contains | +| Not Contains | !contains(str1,str2) | String | Check if string does not contain | +| Matches | matches(str1,str2) | String | Check if string matches regex | +| Not Matches | !matches(str1,str2) | String | Check if string does not match regex | +| Exists | exists(obj) | String, Numeric, Time | Check if value exists | +| Not Exists | !exists(obj) | String, Numeric, Time | Check if value does not exist | +| Greater than | obj1 > obj2 | Numeric, Time | Check if value is greater than | +| Less than | obj1 < obj2 | Numeric, Time | Check if value is less than | +| Greater than or Equal to | obj1 >= obj2 | Numeric, Time | Check if value is greater than or equal to | +| Less than or Equal to | obj1 <= obj2 | Numeric, Time | Check if value is less than or equal to | +| Not Equal to | obj1 != obj2 | Numeric, Time | Check if values are not equal | +| Equal to | obj1 == obj2 | Numeric, Time | Check if values are equal | #### Expression Function Library List -| Supported Function Library | Description | -| -------------------------------- | -------------------------------------------------------------- | -| condition ? trueExpression : falseExpression | Ternary operator | -| toDouble(str) | Convert string to Double type | -| toBoolean(str) | Convert string to Boolean type | -| toInteger(str) | Convert string to Integer type | -| array[n] | Retrieve the nth element of an array | -| * | Multiplication | -| / | Division | -| % | Modulo | -| ( and ) | Parentheses for controlling the order of operations in logical or mathematical expressions | -| + | Addition | -| - | Subtraction | -| && | Logical AND operator | -| \|\| | Logical OR operator | +| Supported Function Library | Description | +|----------------------------------------------|--------------------------------------------------------------------------------------------| +| condition ? trueExpression : falseExpression | Ternary operator | +| toDouble(str) | Convert string to Double type | +| toBoolean(str) | Convert string to Boolean type | +| toInteger(str) | Convert string to Integer type | +| array[n] | Retrieve the nth element of an array | +| * | Multiplication | +| / | Division | +| % | Modulo | +| ( and ) | Parentheses for controlling the order of operations in logical or mathematical expressions | +| + | Addition | +| - | Subtraction | +| && | Logical AND operator | +| \|\| | Logical OR operator | #### Supported Environment Variables @@ -63,4 +63,4 @@ This variable is mainly used for calculations involving multiple instances. For 4. MYSQL Monitoring -> Alert when 'threads_running' metric under 'status' exceeds 7 `threads_running>7` -If you encounter any issues, feel free to discuss and provide feedback through our community group or ISSUE tracker! \ No newline at end of file +If you encounter any issues, feel free to discuss and provide feedback through our community group or ISSUE tracker! diff --git a/home/docs/help/alert_webhook.md b/home/docs/help/alert_webhook.md index adc1b6f12f8..d1741d71481 100644 --- a/home/docs/help/alert_webhook.md +++ b/home/docs/help/alert_webhook.md @@ -5,23 +5,24 @@ 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. +> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient. -### Operation steps +### Operation steps -1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】** +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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) -### WebHook callback POST body BODY content +### WebHook callback POST body BODY content + +Content format：JSON -Content format：JSON ```json { "alarmId": 76456, @@ -43,24 +44,23 @@ Content format：JSON } ``` -| | | -|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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} | - +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 -### Webhook notification common issues +1. WebHook callback did not take effect -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_wework.md b/home/docs/help/alert_wework.md index e862fae7ddf..ca14d5615fa 100644 --- a/home/docs/help/alert_wework.md +++ b/home/docs/help/alert_wework.md @@ -5,34 +5,34 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by enterprise Wechat robot. -### Operation steps +### Operation steps -1. **【Enterprise Wechat】-> 【Group settings】-> 【Group robot】-> 【Add new robot】-> 【Set robot name and avatar】-> 【Copy its webhook address after adding successfully】** +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) +![email](/img/docs/help/alert-notice-6.jpg) -2. **【Save the key value of the WebHook address of the robot】** +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` +> 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】** +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】** +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) +> **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. +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. +> Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/almalinux.md b/home/docs/help/almalinux.md index 380e1439ab4..40a07028c96 100644 --- a/home/docs/help/almalinux.md +++ b/home/docs/help/almalinux.md @@ -4,14 +4,14 @@ title: Monitoring AlmaLinux Operating System Monitoring sidebar_label: AlmaLinux Operating System keywords: [open-source monitoring system, open-source operating system monitoring, AlmaLinux operating system monitoring] --- + > Collect and monitor common performance metrics of the AlmaLinux operating system. ### Configuration Parameters - -| Parameter Name | Parameter Help Description | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note ⚠️ No protocol header (e.g., https://, http://). | +| Parameter Name | Parameter Help Description | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note ⚠️ No protocol header (e.g., https://, http://). | | Task Name | A unique name to identify this monitoring task. | | Port | The port provided by Linux SSH, default is 22. | | Timeout | Set the connection timeout in milliseconds, default is 6000 ms. | @@ -28,18 +28,16 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Basic System Information - -| Metric Name | Metric Unit | Metric Help Description | -| -------------- | ----------- | ------------------------ | +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|--------------------------| | Host Name | None | Host name | | System Version | None | Operating system version | | Uptime | None | Uptime | #### Metric Set: CPU Information - -| Metric Name | Metric Unit | Metric Help Description | -| -------------- | ----------- | --------------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|-----------------------------------| | info | None | CPU model | | cores | Cores | Number of CPU cores | | interrupt | Count | Number of CPU interrupts | @@ -49,9 +47,8 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Memory Information - -| Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------------------| | total | Mb | Total memory capacity | | used | Mb | Memory used by user programs | | free | Mb | Free memory capacity | @@ -61,9 +58,8 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Disk Information - -| Metric Name | Metric Unit | Metric Help Description | -| ------------- | ----------- | -------------------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|----------------------------------------| | disk_num | Count | Total number of disks | | partition_num | Count | Total number of partitions | | block_write | Blocks | Total number of blocks written to disk | @@ -72,18 +68,16 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Network Card Information - -| Metric Name | Metric Unit | Metric Help Description | -| -------------- | ----------- | ----------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|-------------------------------| | interface_name | None | Network card name | | receive_bytes | Byte | Inbound data traffic (bytes) | | transmit_bytes | Byte | Outbound data traffic (bytes) | #### Metric Set: File System - | Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | filesystem | None | Name of the file system | | used | Mb | Used disk size | | available | Mb | Available disk size | @@ -94,9 +88,8 @@ keywords: [open-source monitoring system, open-source operating system monitorin Statistics for the top 10 processes using the CPU. Statistics include: process ID, CPU usage, memory usage, and executed command. - | Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | pid | None | Process ID | | cpu_usage | % | CPU usage | | mem_usage | % | Memory usage | @@ -106,12 +99,12 @@ Statistics for the top 10 processes using the CPU. Statistics include: process I Statistics for the top 10 processes using memory. Statistics include: process ID, memory usage, CPU usage, and executed command. - | Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | pid | None | Process ID | | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | --- + diff --git a/home/docs/help/api.md b/home/docs/help/api.md index 4d93f38e088..37dad9c7ab2 100644 --- a/home/docs/help/api.md +++ b/home/docs/help/api.md @@ -5,33 +5,33 @@ 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. +> 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.cn/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 | -| Headers | HTTP request headers | -| Params | HTTP query params, support [time expression](time_expression) | -| Content-Type | Set the resource type when carrying the BODY request body data request | -| Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| 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 | +| 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.cn/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 | +| Headers | HTTP request headers | +| Params | HTTP query params, support [time expression](time_expression) | +| Content-Type | Set the resource type when carrying the BODY request body data request | +| Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| 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 +### Collection Metric -#### Metric set：summary +#### Metric set：summary -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| responseTime | ms | Website response time | +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | diff --git a/home/docs/help/centos.md b/home/docs/help/centos.md index 2a6ad2b0a6d..60b770ebf96 100644 --- a/home/docs/help/centos.md +++ b/home/docs/help/centos.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source os monitoring tool, monitori ### 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 | +| 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 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 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 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 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 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 | +| 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/docs/help/clickhouse.md b/home/docs/help/clickhouse.md index 3e09687a450..efd873d1f32 100644 --- a/home/docs/help/clickhouse.md +++ b/home/docs/help/clickhouse.md @@ -4,91 +4,93 @@ title: Monitoring ClickHouse Database Monitoring sidebar_label: ClickHouse Database keywords: [open source monitoring system, open source database monitoring, ClickHouse database monitoring] --- + > Collect and monitor general performance metrics for the ClickHouse database. ### Configuration Parameters -| Parameter Name | Parameter Description | -| -------------- | ------------------------------------------------------------------------- | -| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). | -| Task Name | Name identifying this monitoring, ensuring uniqueness. | -| Port | Port number of the database exposed to the outside, default is 8123. | -| Query Timeout | Timeout for SQL queries to respond, in milliseconds (ms), default is 6000ms. | -| Database Name | Name of the database instance, optional. | -| Username | Username for database connection, optional. | -| Password | Password for database connection, optional. | -| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. | -| Tag Binding | Used for categorizing and managing monitored resources. | -| Description | Additional information to identify and describe this monitoring, where users can add remarks. | +| Parameter Name | Parameter Description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). | +| Task Name | Name identifying this monitoring, ensuring uniqueness. | +| Port | Port number of the database exposed to the outside, default is 8123. | +| Query Timeout | Timeout for SQL queries to respond, in milliseconds (ms), default is 6000ms. | +| Database Name | Name of the database instance, optional. | +| Username | Username for database connection, optional. | +| Password | Password for database connection, optional. | +| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. | +| Tag Binding | Used for categorizing and managing monitored resources. | +| Description | Additional information to identify and describe this monitoring, where users can add remarks. | ### Collected Metrics #### Metric Set: ping Availability -| Metric Name | Metric Unit | Metric Description | -| ------------- | ----------- | ------------------ | -| responseTime | N/A | Response time | +| Metric Name | Metric Unit | Metric Description | +|--------------|-------------|--------------------| +| responseTime | N/A | Response time | #### Metric Set: Data from system.metrics table -| Metric Name | Metric Unit | Metric Description | -| ---------------------- | ----------- | ------------------------------------------------------------- | -| Query | N/A | Number of queries being executed | -| Merge | N/A | Number of background merges being executed | -| Move | N/A | Number of background moves being executed | -| PartMutation | N/A | Number of table mutations | -| ReplicatedFetch | N/A | Number of data blocks fetched from replicas | -| ReplicatedSend | N/A | Number of data blocks sent to replicas | -| ReplicatedChecks | N/A | Number of consistency checks on data blocks | -| QueryPreempted | N/A | Number of queries stopped or waiting | -| TCPConnection | N/A | Number of TCP connections | -| HTTPConnection | N/A | Number of HTTP connections | -| OpenFileForRead | N/A | Number of open readable files | -| OpenFileForWrite | N/A | Number of open writable files | -| QueryThread | N/A | Number of threads processing queries | -| ReadonlyReplica | N/A | Number of Replicated tables in read-only state | -| EphemeralNode | N/A | Number of ephemeral nodes in ZooKeeper | -| ZooKeeperWatch | N/A | Number of ZooKeeper event subscriptions | -| StorageBufferBytes | Bytes | Bytes in Buffer tables | -| VersionInteger | N/A | ClickHouse version number | -| RWLockWaitingReaders | N/A | Number of threads waiting for read-write lock on a table | -| RWLockWaitingWriters | N/A | Number of threads waiting for write lock on a table | -| RWLockActiveReaders | N/A | Number of threads holding read lock on a table | -| RWLockActiveWriters | N/A | Number of threads holding write lock on a table | -| GlobalThread | N/A | Number of threads in global thread pool | -| GlobalThreadActive | N/A | Number of active threads in global thread pool | -| LocalThread | N/A | Number of threads in local thread pool | -| LocalThreadActive | N/A | Number of active threads in local thread pool | +| Metric Name | Metric Unit | Metric Description | +|----------------------|-------------|----------------------------------------------------------| +| Query | N/A | Number of queries being executed | +| Merge | N/A | Number of background merges being executed | +| Move | N/A | Number of background moves being executed | +| PartMutation | N/A | Number of table mutations | +| ReplicatedFetch | N/A | Number of data blocks fetched from replicas | +| ReplicatedSend | N/A | Number of data blocks sent to replicas | +| ReplicatedChecks | N/A | Number of consistency checks on data blocks | +| QueryPreempted | N/A | Number of queries stopped or waiting | +| TCPConnection | N/A | Number of TCP connections | +| HTTPConnection | N/A | Number of HTTP connections | +| OpenFileForRead | N/A | Number of open readable files | +| OpenFileForWrite | N/A | Number of open writable files | +| QueryThread | N/A | Number of threads processing queries | +| ReadonlyReplica | N/A | Number of Replicated tables in read-only state | +| EphemeralNode | N/A | Number of ephemeral nodes in ZooKeeper | +| ZooKeeperWatch | N/A | Number of ZooKeeper event subscriptions | +| StorageBufferBytes | Bytes | Bytes in Buffer tables | +| VersionInteger | N/A | ClickHouse version number | +| RWLockWaitingReaders | N/A | Number of threads waiting for read-write lock on a table | +| RWLockWaitingWriters | N/A | Number of threads waiting for write lock on a table | +| RWLockActiveReaders | N/A | Number of threads holding read lock on a table | +| RWLockActiveWriters | N/A | Number of threads holding write lock on a table | +| GlobalThread | N/A | Number of threads in global thread pool | +| GlobalThreadActive | N/A | Number of active threads in global thread pool | +| LocalThread | N/A | Number of threads in local thread pool | +| LocalThreadActive | N/A | Number of active threads in local thread pool | #### Metric Set: Data from system.events table -| Metric Name | Metric Unit | Metric Description | -| ------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- | -| Query | N/A | Number of queries to parse and possibly execute. Excludes queries rejected due to AST size limits, quota limits, or simultaneous query limits. May include internal queries initiated by ClickHouse. Subqueries are not counted. | -| SelectQuery | N/A | Number of Select queries possibly executed | -| InsertQuery | N/A | Number of Insert queries possibly executed | -| InsertedRows | N/A | Number of rows inserted into all tables | -| InsertedBytes | Bytes | Number of bytes inserted into all tables | -| FailedQuery | N/A | Number of failed queries | -| FailedSelectQuery | N/A | Number of failed Select queries | -| FileOpen | N/A | Number of file openings | -| MergeTreeDataWriterRows | N/A | Number of data rows written to MergeTree tables | -| MergeTreeDataWriterCompressedBytes | Bytes | Number of compressed data bytes written to MergeTree tables | +| Metric Name | Metric Unit | Metric Description | +|------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Query | N/A | Number of queries to parse and possibly execute. Excludes queries rejected due to AST size limits, quota limits, or simultaneous query limits. May include internal queries initiated by ClickHouse. Subqueries are not counted. | +| SelectQuery | N/A | Number of Select queries possibly executed | +| InsertQuery | N/A | Number of Insert queries possibly executed | +| InsertedRows | N/A | Number of rows inserted into all tables | +| InsertedBytes | Bytes | Number of bytes inserted into all tables | +| FailedQuery | N/A | Number of failed queries | +| FailedSelectQuery | N/A | Number of failed Select queries | +| FileOpen | N/A | Number of file openings | +| MergeTreeDataWriterRows | N/A | Number of data rows written to MergeTree tables | +| MergeTreeDataWriterCompressedBytes | Bytes | Number of compressed data bytes written to MergeTree tables | #### Metric Set: Data from system.asynchronous_metrics table -| Metric Name | Metric Unit | Metric Description | -| -------------------------------------- | ----------- | -------------------------------------- | -| AsynchronousMetricsCalculationTimeSpent | N/A | Time spent calculating asynchronous metrics (seconds) | -| jemalloc.arenas.all.muzzy_purged | N/A | Number of purged muzzy pages | -| jemalloc.arenas.all.dirty_purged | N/A | Number of purged dirty pages | -| BlockReadBytes_ram1 | N/A | Number of bytes read from ram1 block | -| jemalloc.background_thread.run_intervals | N/A | Number of intervals jemalloc background thread ran | -| BlockQueueTime_nbd13 | N/A | Queue wait time for nbd13 block | -| jemalloc.background_thread.num_threads | N/A | Number of jemalloc background threads | -| jemalloc.resident | N/A | Physical memory size allocated by jemalloc (bytes) | -| InterserverThreads | N/A | Number of Interserver threads | -| BlockWriteMerges_nbd7 | N/A | Number of block write merges for nbd7 block | -| MarkCacheBytes | N/A | Size of marks cache in StorageMergeTree | -| MarkCacheFiles | N/A | Number of files in marks cache for StorageMergeTree | -| MaxPartCountForPartition | N/A | Maximum active data blocks in partitions | \ No newline at end of file +| Metric Name | Metric Unit | Metric Description | +|------------------------------------------|-------------|-------------------------------------------------------| +| AsynchronousMetricsCalculationTimeSpent | N/A | Time spent calculating asynchronous metrics (seconds) | +| jemalloc.arenas.all.muzzy_purged | N/A | Number of purged muzzy pages | +| jemalloc.arenas.all.dirty_purged | N/A | Number of purged dirty pages | +| BlockReadBytes_ram1 | N/A | Number of bytes read from ram1 block | +| jemalloc.background_thread.run_intervals | N/A | Number of intervals jemalloc background thread ran | +| BlockQueueTime_nbd13 | N/A | Queue wait time for nbd13 block | +| jemalloc.background_thread.num_threads | N/A | Number of jemalloc background threads | +| jemalloc.resident | N/A | Physical memory size allocated by jemalloc (bytes) | +| InterserverThreads | N/A | Number of Interserver threads | +| BlockWriteMerges_nbd7 | N/A | Number of block write merges for nbd7 block | +| MarkCacheBytes | N/A | Size of marks cache in StorageMergeTree | +| MarkCacheFiles | N/A | Number of files in marks cache for StorageMergeTree | +| MaxPartCountForPartition | N/A | Maximum active data blocks in partitions | + diff --git a/home/docs/help/debian.md b/home/docs/help/debian.md index 65940c34a39..14cee060aaf 100644 --- a/home/docs/help/debian.md +++ b/home/docs/help/debian.md @@ -4,13 +4,13 @@ title: Monitoring Debian System Monitoring sidebar_label: Debian keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Monitoring] --- + > Collect and monitor general performance metrics of the Debian system. ## Configuration Parameters - -| Parameter Name | Metric help description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Metric help description | +|-------------------------|-------------------------------------------------------------------------------------------------------------------| | Target Host | The monitored destination IPV4, IPV6, or domain name. Note: no protocol header (e.g., https://, http://). | | Task Name | A unique name to identify this monitoring task. | | Port | SSH port of the Debian system, default: 22 | @@ -28,18 +28,16 @@ keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Mo #### Metric Set: Basic System Information - -| Metric Name | Metric Unit | Metric help description | -| -------------- | ----------- | ------------------------ | +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|--------------------------| | Host Name | N/A | Host name | | System Version | N/A | Operating system version | | Uptime | N/A | Boot time | #### Metric Set: CPU Information - -| Metric Name | Metric Unit | Metric help description | -| -------------- | ----------- | ----------------------- | +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|-------------------------| | Info | N/A | Model | | Cores | N/A | Number of cores | | Interrupt | N/A | Number of interrupts | @@ -49,9 +47,8 @@ keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Mo #### Metric Set: Memory Information - -| Metric Name | Metric Unit | Metric help description | -| ------------------- | ----------- | ---------------------------- | +| Metric Name | Metric Unit | Metric help description | +|---------------------|-------------|------------------------------| | Total Memory | Mb | Total memory capacity | | User Program Memory | Mb | Memory used by user programs | | Free Memory | Mb | Free memory capacity | @@ -61,9 +58,8 @@ keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Mo #### Metric Set: Disk Information - -| Metric Name | Metric Unit | Metric help description | -| ------------- | ----------- | ----------------------------- | +| Metric Name | Metric Unit | Metric help description | +|---------------|-------------|-------------------------------| | Disk Num | N/A | Total number of disks | | Partition Num | N/A | Total number of partitions | | Block Write | N/A | Number of disk blocks written | @@ -99,3 +95,4 @@ Metric Unit: - Memory Usage Rate: % - CPU Usage Rate: % + diff --git a/home/docs/help/dm.md b/home/docs/help/dm.md index 91b032fdf54..82159bf2408 100644 --- a/home/docs/help/dm.md +++ b/home/docs/help/dm.md @@ -9,41 +9,41 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | +| 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/docs/help/dns.md b/home/docs/help/dns.md index 7587452c1a7..d8dbd8d0921 100644 --- a/home/docs/help/dns.md +++ b/home/docs/help/dns.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -28,7 +28,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito #### Metrics Set：Header -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|---------------------------------------------------| | Response Time | ms | Time taken for DNS server to respond to requests. | | Opcode | none | Type of the current message. | @@ -41,13 +41,13 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Metrics Set: Question -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------| | Section | none | Question record information, including the queried domain name, resource type, resource record class, and additional information. | ### Metrics Set: Answer -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|----------------------------------------------------------------------------------------------------------------------------| | Section0 | none | Answer record information, including the queried domain name, TTL, resource record class, resource type, and query result. | @@ -55,7 +55,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Metrics Set: Authority -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| | Section0 | none | SOA (Start of Authority) record for the domain name, including queried domain name, TTL, resource type, resource record class, and other information. | @@ -63,8 +63,9 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Metrics Set: Additional -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-----------------------------------------| | Section0 | none | Additional information for DNS queries. | > The metric set collects up to 10 records, with metric names from Section0 to Section9. + diff --git a/home/docs/help/docker.md b/home/docs/help/docker.md index fdd3098ce55..0e3a1f0b428 100644 --- a/home/docs/help/docker.md +++ b/home/docs/help/docker.md @@ -7,7 +7,6 @@ keywords: [open source monitoring tool, open source docker monitoring tool, moni > 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. @@ -31,7 +30,7 @@ This is equivalent to the **2375** port that is open to the outside world. Of co ```shell systemctl daemon-reload systemctl restart docker -```` +``` **Note: Remember to open the `2375` port number in the server console. ** @@ -42,65 +41,62 @@ 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 | +| 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 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 | +| 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 | +| 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/docs/help/doris_be.md b/home/docs/help/doris_be.md index 2bc212ef3fb..8dcde7b549b 100644 --- a/home/docs/help/doris_be.md +++ b/home/docs/help/doris_be.md @@ -9,162 +9,163 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8040 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| 数据库名称 | 数据库实例名称，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8040 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| 数据库名称 | 数据库实例名称，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：doris_be_load_channel_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| value | 无 | 当前打开的 load channel 个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------------| +| value | 无 | 当前打开的 load channel 个数 | #### 指标集合：doris_be_memtable_flush_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| value | 无 | memtable写入磁盘的个数累计值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | memtable写入磁盘的个数累计值 | #### 指标集合：doris_be_plan_fragment_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------- | -| value | 无 | 当前已接收的 fragment instance 的数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------| +| value | 无 | 当前已接收的 fragment instance 的数量 | #### 指标集合：doris_be_process_thread_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------- | -| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | #### 指标集合：doris_be_query_scan_rows -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------------------------------------------| +| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | #### 指标集合：doris_be_result_buffer_block_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------- | -| value | 无 | 当前查询结果缓存中的 query 个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 当前查询结果缓存中的 query 个数 | #### 指标集合：doris_be_send_batch_thread_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------------- | -| value | 无 | 导入时用于发送数据包的线程池的排队个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 导入时用于发送数据包的线程池的排队个数 | #### 指标集合：doris_be_tablet_base_max_compaction_score -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------- | -| value | 无 | 当前最大的 Base Compaction Score | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------------------| +| value | 无 | 当前最大的 Base Compaction Score | #### 指标集合：doris_be_timeout_canceled_fragment_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------------------- | -| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------------| +| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | #### 指标集合：doris_be_load_rows -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------- | -| value | 无 | 通过 tablet sink 发送的行数累计 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------| +| value | 无 | 通过 tablet sink 发送的行数累计 | #### 指标集合：doris_be_all_rowsets_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------- | -| value | 无 | 当前所有 rowset 的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 当前所有 rowset 的个数 | #### 指标集合：doris_be_all_segments_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------- | -| value | 无 | 当前所有 segment 的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| value | 无 | 当前所有 segment 的个数 | #### 指标集合：doris_be_heavy_work_max_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------ | -| value | 无 | brpc heavy线程池线程个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | brpc heavy线程池线程个数 | #### 指标集合：doris_be_light_work_max_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------ | -| value | 无 | brpc light线程池线程个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | brpc light线程池线程个数 | #### 指标集合：doris_be_heavy_work_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------------- | -| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | #### 指标集合：doris_be_light_work_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------------- | -| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | #### 指标集合：doris_be_heavy_work_active_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------- | -| value | 无 | brpc heavy线程池活跃线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | brpc heavy线程池活跃线程数 | #### 指标集合：doris_be_light_work_active_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------- | -| value | 无 | brpc light线程池活跃线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | brpc light线程池活跃线程数 | #### 指标集合：doris_be_compaction_bytes_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------------------------- | -| base | 字节 | Base Compaction 的数据量累计 | -| cumulative | 字节 | Cumulative Compaction 的数据量累计 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|------------------------------| +| base | 字节 | Base Compaction 的数据量累计 | +| cumulative | 字节 | Cumulative Compaction 的数据量累计 | #### 指标集合：doris_be_disks_avail_capacity -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------- | -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------| +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | #### 指标集合：doris_be_disks_total_capacity -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------- | -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------| +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | #### 指标集合：doris_be_local_bytes_read_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------- | -| value | 字节 | 由 `LocalFileReader` 读取的字节数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------| +| value | 字节 | 由 `LocalFileReader` 读取的字节数 | #### 指标集合：doris_be_local_bytes_written_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------- | -| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------| +| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | #### 指标集合：doris_be_memory_allocated_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------------------------- | -| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------| +| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | + diff --git a/home/docs/help/doris_fe.md b/home/docs/help/doris_fe.md index bb7a6b99d53..b478b2eaadb 100644 --- a/home/docs/help/doris_fe.md +++ b/home/docs/help/doris_fe.md @@ -4,6 +4,7 @@ title: Monitoring DORIS Database FE Monitoring sidebar_label: DORIS Database FE keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database FE Monitoring] --- + > Collect and monitor general performance metrics for DORIS database FE. Supports DORIS 2.0.0. **Protocol: HTTP** @@ -14,9 +15,8 @@ Check the `fe/conf/fe.conf` file to obtain the value of the `http_port` configur ### Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Parameter Description | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Monitor Host | The monitored target's IPV4, IPV6, or domain name. Note: Without the protocol header (e.g., https://, http://) | | Task Name | A unique name identifying this monitoring task | | Port | The port provided by the database to the outside, default is 8030 ,get the value of the`http_port` configuration item | @@ -30,26 +30,23 @@ Check the `fe/conf/fe.conf` file to obtain the value of the `http_port` configur #### Metric Set: doris_fe_connection_total - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------| | value | None | The current number of MySQL port connections on FE | #### Metric Set: doris_fe_edit_log_clean Should not fail; if it does, manual intervention is required. - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|---------------------------------------------------------------| | success | None | The number of successful cleanups of historical metadata logs | | failed | None | The number of failed cleanups of historical metadata logs | #### Metric Set: doris_fe_edit_log - -| Metric Name | Metric Unit | Metric help description | -| ----------------- | ----------- | ------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------------|-------------|---------------------------------------------| | write | None | The count of metadata log write operations | | read | None | The count of metadata log read operations | | current | None | The current number of metadata logs | @@ -60,9 +57,8 @@ Should not fail; if it does, manual intervention is required. Should not fail; if it does, manual intervention is required. - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------| | success | None | The number of successful cleanups of historical metadata image files | | failed | None | The number of failed cleanups of historical metadata image files | @@ -70,77 +66,68 @@ Should not fail; if it does, manual intervention is required. Should not fail; if it does, manual intervention is required. - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------ | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------------------------------| | success | None | The number of successful generations of metadata image files | | failed | None | The number of failed generations of metadata image files | #### Metric Set: doris_fe_query_err - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ----------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------------------------| | value | None | The cumulative value of erroneous queries | #### Metric Set: doris_fe_max_journal_id - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The current maximum metadata log ID on the FE node. If it is a Master FE, it is the maximum ID currently written; if it is a non-Master FE, it represents the maximum metadata log ID currently being replayed. Used to observe if there is a large gap between the IDs of multiple FEs. A large gap indicates issues with metadata synchronization | #### Metric Set: doris_fe_max_tablet_compaction_score - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The largest compaction score value among all BE nodes. This value can observe the current cluster's maximum compaction score to judge if it is too high. If too high, there may be delays in queries or writes | #### Metric Set: doris_fe_qps - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|---------------------------------------------------------------------------------| | value | None | The number of queries per second on the current FE (only counts query requests) | #### Metric Set: doris_fe_query_err_rate - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------ | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------------| | value | None | The number of erroneous queries per second | #### Metric Set: doris_fe_report_queue_size - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The length of the queue for various regular reporting tasks on the BE side at the FE end. This value reflects the degree of blocking of reporting tasks on the Master FE node. A larger value indicates insufficient processing capacity on the FE | #### Metric Set: doris_fe_rps - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ---------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|------------------------------------------------------------------------------------------------------| | value | None | The number of requests per second on the current FE (includes queries and other types of statements) | #### Metric Set: doris_fe_scheduled_tablet_num - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The number of tablets currently being scheduled by the Master FE node. This includes tablets that are being repaired and tablets that are being balanced. This value can reflect the number of tablets currently migrating in the cluster. If there is a value for a long time, it indicates that the cluster is unstable | #### Metric Set: doris_fe_txn_status Can observe the number of import transactions in various states to determine if there is a backlog. - | Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | unknown | None | Unknown state | | prepare | None | In preparation | | committed | None | Committed | | visible | None | Visible | | aborted | None | Aborted / Revoked | + diff --git a/home/docs/help/dynamic_tp.md b/home/docs/help/dynamic_tp.md index 7418e17cc1b..fd36206bc6e 100644 --- a/home/docs/help/dynamic_tp.md +++ b/home/docs/help/dynamic_tp.md @@ -24,6 +24,7 @@ management: exposure: include: '*' ``` + Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has response json data as follows: ```json @@ -60,7 +61,6 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo 3. Add DynamicTp monitoring under HertzBeat middleware monitoring - ### Configuration parameters | Parameter name | Parameter help description | @@ -78,24 +78,25 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo #### 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 | +| 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/docs/help/elasticsearch.md b/home/docs/help/elasticsearch.md index 25078850862..3ac3d62a7e1 100644 --- a/home/docs/help/elasticsearch.md +++ b/home/docs/help/elasticsearch.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -27,7 +27,7 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] #### Metrics Set：health -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-----------------------|-------------|-------------------------------------------| | cluster_name | none | Cluster Name | | status | none | status | @@ -49,7 +49,7 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] #### Metrics Set：nodes_detail -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------------|-------------|-------------------------| | node_name | none | Node Name | | ip | none | IP Address | @@ -61,3 +61,4 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] | disk_free | GB | Disk Free | | disk_total | GB | Disk Total | | disk_used_percent | % | Disk Used Percent | + diff --git a/home/docs/help/euleros.md b/home/docs/help/euleros.md index c63c6c26643..786dab30afc 100644 --- a/home/docs/help/euleros.md +++ b/home/docs/help/euleros.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitoring, ensuring uniqueness. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|---------------------------| | Host Name | None | Host name. | | System Version | None | Operating system version. | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|-------------------------------------------| | info | None | CPU model. | | cores | None | Number of CPU cores. | @@ -47,7 +47,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Memory Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|------------------------------------| | total | Mb | Total memory capacity. | | used | Mb | Used memory by user programs. | @@ -58,7 +58,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Disk Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------|-------------|------------------------------------| | disk_num | None | Total number of disks. | | partition_num | None | Total number of partitions. | @@ -68,7 +68,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Interface Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------------| | interface_name | None | Name of the network interface. | | receive_bytes | Mb | Inbound data traffic. | @@ -105,3 +105,4 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/docs/help/flink.md b/home/docs/help/flink.md index 2115a1f0b0f..bd731a6dee6 100644 --- a/home/docs/help/flink.md +++ b/home/docs/help/flink.md @@ -7,10 +7,9 @@ keywords: [open source monitoring tool, open source flink monitoring tool] > Collect and monitor the general performance Metrics of Flink. - ### Configuration parameter -| Parameter Name | Parameter Help Description | +| Parameter Name | Parameter Help Description | |---------------------|-----------------------------------------------------------------------------------------------------------------------------| | Monitor Host | The monitored peer IPV4, IPV6, or domain name. Note: Do not include protocol headers (e.g., https://, http://). | | Task Name | Identifier for this monitoring task, name must be unique. | @@ -27,13 +26,11 @@ keywords: [open source monitoring tool, open source flink monitoring tool] #### Metrics Set：Overview -| Metric Name | Metric Unit | Metric Help Description | -|---------------|-------------|-------------------------| -| slots_total | Units | Total number of slots. | -| slots_used | Units | Number of slots used. | -| task_total | Units | Total number of tasks. | -| jobs_running | Units | Number of jobs running. | -| jobs_failed | Units | Number of jobs failed. | - - +| Metric Name | Metric Unit | Metric Help Description | +|--------------|-------------|-------------------------| +| slots_total | Units | Total number of slots. | +| slots_used | Units | Number of slots used. | +| task_total | Units | Total number of tasks. | +| jobs_running | Units | Number of jobs running. | +| jobs_failed | Units | Number of jobs failed. | diff --git a/home/docs/help/freebsd.md b/home/docs/help/freebsd.md index 96d9866743b..51d0ed9ab0b 100644 --- a/home/docs/help/freebsd.md +++ b/home/docs/help/freebsd.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source Operating System Monitori ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | | Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source Operating System Monitori #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------| | Host Name | None | Host name | | System Version | None | Operating system version | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source Operating System Monitori #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|----------------------------------------------| | info | None | CPU model | | cores | Number | Number of CPU cores | @@ -85,3 +85,4 @@ Statistics of the top 10 processes using memory. Statistics include: Process ID, | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/docs/help/ftp.md b/home/docs/help/ftp.md index 8802d3ab415..50a571eb7a7 100644 --- a/home/docs/help/ftp.md +++ b/home/docs/help/ftp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source ftp server monitoring tool, ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: ftp://). | | Monitoring name | Identify the name of this monitoring, The name needs to be unique. | @@ -28,7 +28,8 @@ keywords: [ open source monitoring tool, open source ftp server monitoring tool, #### Metrics Set：Basic -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |---------------|-------------|----------------------------------------------------------| | Is Active | none | Check if the directory exists and has access permission. | | Response Time | ms | Response Time | + diff --git a/home/docs/help/fullsite.md b/home/docs/help/fullsite.md index 3246fa31d82..6145f238bdc 100644 --- a/home/docs/help/fullsite.md +++ b/home/docs/help/fullsite.md @@ -7,28 +7,29 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon > 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. +> Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. -### Configuration parameter +### 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 | +| 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 +### Collection Metric -#### Metric set：summary +#### 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 | -| 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/docs/help/guide.md b/home/docs/help/guide.md index 5f7af25ac16..ce182746ffa 100644 --- a/home/docs/help/guide.md +++ b/home/docs/help/guide.md @@ -1,137 +1,134 @@ ---- -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)
- 👉 [DNS monitoring](dns)
- 👉 [FTP monitoring](ftp)
- 👉 [Websocket monitoring](websocket)
- -### Program monitoring - - 👉 [Process](process)
- 👉 [JVM monitoring](jvm)
- 👉 [SpringBoot2.0](springboot2)
- 👉 [SpringBoot3.0](springboot3)
- 👉 [DynamicTp](dynamic_tp)
- -### Database monitoring - - 👉 [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)
- 👉 [TiDB database monitoring](tidb)
- 👉 [MongoDB database monitoring](mongodb)
- 👉 [NebulaGraph cluster monitoring](nebulagraph_cluster)
- -### Cache monitoring - - 👉 [Redis monitoring](redis)
- 👉 [Memcached monitoring](memcached)
- - -### Operating system monitoring - - 👉 [Linux operating system monitoring](linux)
- 👉 [Windows operating system monitoring](windows)
- 👉 [Ubuntu operating system monitoring](ubuntu)
- 👉 [Centos operating system monitoring](centos)
- 👉 [FreeBSD operating system monitoring](freebsd)
- 👉 [RedHat operating system monitoring](redhat)
- 👉 [Rocky Linux operating system monitoring](rockylinux)
- 👉 [EulerOS monitoring](euleros)
- -### Middleware monitoring - - 👉 [Zookeeper](zookeeper)
- 👉 [Kafka](kafka)
- 👉 [Tomcat](tomcat)
- 👉 [ShenYu](shenyu)
- 👉 [DynamicTp](dynamic_tp)
- 👉 [RabbitMQ](rabbitmq)
- 👉 [ActiveMQ](activemq)
- 👉 [Jetty](jetty)
- 👉 [Nacos](nacos)
- -### CloudNative monitoring - - 👉 [Docker](docker)
- 👉 [Kubernetes](kubernetes)
- -### Bigdata monitoring - - 👉 [Clickhouse](clickhouse)
- 👉 [ElasticSearch](elasticsearch)
- 👉 [Flink](flink)
- -### Ai LLM monitoring - - 👉 [openai](openai)
- -### Network monitoring - - 👉 [Huawei-switch](huawei_switch)
- -### Server monitoring - - -*** - -## 💡 Alarm service - -> 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)
- 👉 [Configure Huawei Cloud SMN Notification](alert_smn)
- -### Plugins - - 👉 [Plugin](plugin)
\ No newline at end of file +--- +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)
+ 👉 [DNS monitoring](dns)
+ 👉 [FTP monitoring](ftp)
+ 👉 [Websocket monitoring](websocket)
+ +### Program monitoring + + 👉 [Process](process)
+ 👉 [JVM monitoring](jvm)
+ 👉 [SpringBoot2.0](springboot2)
+ 👉 [SpringBoot3.0](springboot3)
+ 👉 [DynamicTp](dynamic_tp)
+ +### Database monitoring + + 👉 [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)
+ 👉 [TiDB database monitoring](tidb)
+ 👉 [MongoDB database monitoring](mongodb)
+ 👉 [NebulaGraph cluster monitoring](nebulagraph_cluster)
+ +### Cache monitoring + + 👉 [Redis monitoring](redis)
+ 👉 [Memcached monitoring](memcached)
+ +### Operating system monitoring + + 👉 [Linux operating system monitoring](linux)
+ 👉 [Windows operating system monitoring](windows)
+ 👉 [Ubuntu operating system monitoring](ubuntu)
+ 👉 [Centos operating system monitoring](centos)
+ 👉 [FreeBSD operating system monitoring](freebsd)
+ 👉 [RedHat operating system monitoring](redhat)
+ 👉 [Rocky Linux operating system monitoring](rockylinux)
+ 👉 [EulerOS monitoring](euleros)
+ +### Middleware monitoring + + 👉 [Zookeeper](zookeeper)
+ 👉 [Kafka](kafka)
+ 👉 [Tomcat](tomcat)
+ 👉 [ShenYu](shenyu)
+ 👉 [DynamicTp](dynamic_tp)
+ 👉 [RabbitMQ](rabbitmq)
+ 👉 [ActiveMQ](activemq)
+ 👉 [Jetty](jetty)
+ 👉 [Nacos](nacos)
+ +### CloudNative monitoring + + 👉 [Docker](docker)
+ 👉 [Kubernetes](kubernetes)
+ +### Bigdata monitoring + + 👉 [Clickhouse](clickhouse)
+ 👉 [ElasticSearch](elasticsearch)
+ 👉 [Flink](flink)
+ +### Ai LLM monitoring + + 👉 [openai](openai)
+ +### Network monitoring + + 👉 [Huawei-switch](huawei_switch)
+ +### Server monitoring + +*** + +## 💡 Alarm service + +> 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)
+ 👉 [Configure Huawei Cloud SMN Notification](alert_smn)
+ +### Plugins + + 👉 [Plugin](plugin)
diff --git a/home/docs/help/hadoop.md b/home/docs/help/hadoop.md index f0a458ecc9f..56f19472277 100644 --- a/home/docs/help/hadoop.md +++ b/home/docs/help/hadoop.md @@ -11,9 +11,10 @@ keywords: [Open Source Monitoring System, Open Source Java Monitoring, Hadoop JV ### 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. +> 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: @@ -31,12 +32,12 @@ export HADOOP_OPTS= "$HADOOP_OPTS -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. +- 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 | +| 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 | @@ -70,16 +71,15 @@ export HADOOP_OPTS= "$HADOOP_OPTS #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -88,4 +88,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/hbase_master.md b/home/docs/help/hbase_master.md index 188ad146a5a..1e3efe84af7 100644 --- a/home/docs/help/hbase_master.md +++ b/home/docs/help/hbase_master.md @@ -4,6 +4,7 @@ title: Monitoring Hbase Master sidebar_label: HbaseMaster Monitoring keywords: [Open Source Monitoring System, Open Source Database Monitoring, HbaseMaster Monitoring] --- + > Collect monitoring data for general performance metrics of Hbase Master. **Protocol: HTTP** @@ -14,13 +15,12 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po ## Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note: without protocol header (e.g., https://, http://). | | Port | The port number of the Hbase master, default is 16010. That is, the value of the`hbase.master.info.port` parameter. | | Task Name | The name identifying this monitoring, which needs to be unique. | -| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | +| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | | Collection Interval | The periodic collection interval for monitoring data, in seconds, with the minimum allowable interval being 30 seconds. | | Probe | Whether to probe and check the availability of monitoring before adding new monitoring, and proceed with the addition or modification operation only if the probe is successful. | | Description | Additional notes and descriptions for this monitoring, users can add notes here. | @@ -29,9 +29,8 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po #### Metric Set: server - -| Metric Name | Unit | Metric Description | -| -------------------- | ---- | --------------------------------------- | +| Metric Name | Unit | Metric Description | +|----------------------|------|-----------------------------------------| | numRegionServers | none | Number of currently alive RegionServers | | numDeadRegionServers | none | Number of currently dead RegionServers | | averageLoad | none | Cluster average load | @@ -39,18 +38,16 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po #### Metric Set: Rit - -| Metric Name | Unit | Metric Description | -| -------------------- | ---- | -------------------------------- | +| Metric Name | Unit | Metric Description | +|----------------------|------|----------------------------------| | ritnone | none | Current number of RIT | | ritnoneOverThreshold | none | Number of RIT over the threshold | | ritOldestAge | ms | Duration of the oldest RIT | #### Metric Set: basic - -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | ------------------------------------------- | +| Metric Name | Unit | Metric Description | +|-------------------------|------|---------------------------------------------| | liveRegionServers | none | List of currently active RegionServers | | deadRegionServers | none | List of currently offline RegionServers | | zookeeperQuorum | none | Zookeeper list | @@ -60,3 +57,4 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po | receivedBytes | MB | Cluster received data volume | | sentBytes | MB | Cluster sent data volume (MB) | | clusterRequests | none | Total number of cluster requests | + diff --git a/home/docs/help/hbase_regionserver.md b/home/docs/help/hbase_regionserver.md index 4e676491022..0a77eb5441b 100644 --- a/home/docs/help/hbase_regionserver.md +++ b/home/docs/help/hbase_regionserver.md @@ -4,6 +4,7 @@ title: Monitoring HBase RegionServer Monitoring sidebar_label: HBase RegionServer Monitoring keywords: [Open-source monitoring system, Open-source database monitoring, RegionServer monitoring] --- + > Collect and monitor common performance metrics for HBase RegionServer. **Protocol:** HTTP @@ -14,13 +15,12 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. ## Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| Target Host | The IPV4, IPV6, or domain name of the monitored entity. Note ⚠️ Do not include the protocol header (e.g., https://, http://). | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | The IPV4, IPV6, or domain name of the monitored entity. Note ⚠️ Do not include the protocol header (e.g., https://, http://). | | Port | The port number of the HBase regionserver, default is 16030, i.e., the value of the`hbase.regionserver.info.port` parameter | | Task Name | A unique name to identify this monitoring task. | -| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | +| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | | Collection Interval | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | | Probe Before Adding | Whether to probe and check the availability of monitoring before adding new monitoring, only proceed with the addition if the probe is successful. | | Description Note | Additional notes to identify and describe this monitoring, users can add notes here. | @@ -31,9 +31,8 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. #### Metric Set: server - -| Metric Name | Unit | Metric Description | -| --------------------------------- | ----- | ------------------------------------------------------------------------- | +| Metric Name | Unit | Metric Description | +|-----------------------------------|-------|---------------------------------------------------------------------------| | regionCount | None | Number of Regions | | readRequestCount | None | Number of read requests since cluster restart | | writeRequestCount | None | Number of write requests since cluster restart | @@ -74,9 +73,8 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. #### Metric Set: IPC - -| Metric Name | Unit | Metric Description | -| ------------------------- | ---- | -------------------------------------- | +| Metric Name | Unit | Metric Description | +|---------------------------|------|----------------------------------------| | numActiveHandler | None | Current number of RITs | | NotServingRegionException | None | Number of RITs exceeding the threshold | | RegionMovedException | ms | Duration of the oldest RIT | @@ -84,9 +82,8 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. #### Metric Set: JVM - -| Metric Name | Unit | Metric Description | -| -------------------- | ---- | --------------------------------- | +| Metric Name | Unit | Metric Description | +|----------------------|------|-----------------------------------| | MemNonHeapUsedM | None | Current active RegionServer list | | MemNonHeapCommittedM | None | Current offline RegionServer list | | MemHeapUsedM | None | Zookeeper list | @@ -94,3 +91,4 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. | MemHeapMaxM | None | Cluster balance load times | | MemMaxM | None | RPC handle count | | GcCount | MB | Cluster data reception volume | + diff --git a/home/docs/help/hdfs_datanode.md b/home/docs/help/hdfs_datanode.md index 2e09fb9fba1..164adc7d6df 100644 --- a/home/docs/help/hdfs_datanode.md +++ b/home/docs/help/hdfs_datanode.md @@ -15,42 +15,43 @@ Retrieve the HTTP monitoring port for the Apache HDFS DataNode. Value: `dfs.data ## Configuration Parameters -| Parameter Name | Parameter Description | -| ----------------- |-------------------------------------------------------| -| Target Host | IP(v4 or v6) or domain name of the target to be monitored. Exclude protocol. | -| Port | Monitoring port number for Apache HDFS DataNode, default is 50075. | -| Query Timeout | Timeout for querying Apache HDFS DataNode, in milliseconds, default is 6000 milliseconds. | +| Parameter Name | Parameter Description | +|-----------------------------|-------------------------------------------------------------------------------------------| +| Target Host | IP(v4 or v6) or domain name of the target to be monitored. Exclude protocol. | +| Port | Monitoring port number for Apache HDFS DataNode, default is 50075. | +| Query Timeout | Timeout for querying Apache HDFS DataNode, in milliseconds, default is 6000 milliseconds. | | Metrics Collection Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. | -| Probe Before Monitoring | Whether to probe and check monitoring availability before adding. | -| Description/Remarks | Additional description and remarks for this monitoring. | +| Probe Before Monitoring | Whether to probe and check monitoring availability before adding. | +| Description/Remarks | Additional description and remarks for this monitoring. | ### Metrics Collected #### Metric Set: FSDatasetState -| Metric Name | Metric Unit | Metric Description | -| ------------ | ----------- | ------------------------------ | -| DfsUsed | GB | DataNode HDFS usage | -| Remaining | GB | Remaining space on DataNode HDFS | -| Capacity | GB | Total capacity of DataNode HDFS | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|----------------------------------| +| DfsUsed | GB | DataNode HDFS usage | +| Remaining | GB | Remaining space on DataNode HDFS | +| Capacity | GB | Total capacity of DataNode HDFS | #### Metric Set: JvmMetrics -| Metric Name | Metric Unit | Metric Description | -| ---------------------- | ----------- | ----------------------------------------- | -| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | -| MemNonHeapCommittedM | MB | Committed size of NonHeapMemory configured in JVM | -| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | -| MemHeapCommittedM | MB | Committed size of HeapMemory by JVM | -| MemHeapMaxM | MB | Maximum size of HeapMemory configured in JVM | -| MemMaxM | MB | Maximum memory available for JVM at runtime | -| ThreadsRunnable | Count | Number of threads in RUNNABLE state | -| ThreadsBlocked | Count | Number of threads in BLOCKED state | -| ThreadsWaiting | Count | Number of threads in WAITING state | -| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | +| Metric Name | Metric Unit | Metric Description | +|----------------------|-------------|---------------------------------------------------| +| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | +| MemNonHeapCommittedM | MB | Committed size of NonHeapMemory configured in JVM | +| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | +| MemHeapCommittedM | MB | Committed size of HeapMemory by JVM | +| MemHeapMaxM | MB | Maximum size of HeapMemory configured in JVM | +| MemMaxM | MB | Maximum memory available for JVM at runtime | +| ThreadsRunnable | Count | Number of threads in RUNNABLE state | +| ThreadsBlocked | Count | Number of threads in BLOCKED state | +| ThreadsWaiting | Count | Number of threads in WAITING state | +| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | #### Metric Set: runtime -| Metric Name | Metric Unit | Metric Description | -| ------------ | ----------- | ------------------ | -| StartTime | | Startup time | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|--------------------| +| StartTime | | Startup time | + diff --git a/home/docs/help/hdfs_namenode.md b/home/docs/help/hdfs_namenode.md index 1afd6d4b1ae..978daac3613 100644 --- a/home/docs/help/hdfs_namenode.md +++ b/home/docs/help/hdfs_namenode.md @@ -15,78 +15,79 @@ Ensure that you have obtained the JMX monitoring port for the HDFS NameNode. ## Configuration Parameters -| Parameter Name | Parameter Description | -| ------------------ |--------------------------------------------------------| -| Target Host | The IPv4, IPv6, or domain name of the target being monitored. Exclude protocol headers. | -| Port | The monitoring port number of the HDFS NameNode, default is 50070. | -| Query Timeout | Timeout for querying the HDFS NameNode, in milliseconds, default is 6000 milliseconds. | +| Parameter Name | Parameter Description | +|-----------------------------|-------------------------------------------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the target being monitored. Exclude protocol headers. | +| Port | The monitoring port number of the HDFS NameNode, default is 50070. | +| Query Timeout | Timeout for querying the HDFS NameNode, in milliseconds, default is 6000 milliseconds. | | Metrics Collection Interval | Time interval for collecting monitoring data, in seconds, minimum interval is 30 seconds. | -| Probe Before Monitoring | Whether to probe and check the availability of monitoring before adding it. | -| Description/Remarks | Additional description and remarks for this monitoring. | +| Probe Before Monitoring | Whether to probe and check the availability of monitoring before adding it. | +| Description/Remarks | Additional description and remarks for this monitoring. | ### Collected Metrics #### Metric Set: FSNamesystem -| Metric Name | Metric Unit | Metric Description | -| --------------------------- | ----------- | ------------------------------------- | -| CapacityTotal | | Total cluster storage capacity | -| CapacityTotalGB | GB | Total cluster storage capacity | -| CapacityUsed | | Used cluster storage capacity | -| CapacityUsedGB | GB | Used cluster storage capacity | -| CapacityRemaining | | Remaining cluster storage capacity | -| CapacityRemainingGB | GB | Remaining cluster storage capacity | -| CapacityUsedNonDFS | | Non-HDFS usage of cluster capacity | -| TotalLoad | | Total client connections in the cluster | -| FilesTotal | | Total number of files in the cluster | -| BlocksTotal | | Total number of BLOCKs | -| PendingReplicationBlocks | | Number of blocks awaiting replication | -| UnderReplicatedBlocks | | Number of blocks with insufficient replicas | -| CorruptBlocks | | Number of corrupt blocks | -| ScheduledReplicationBlocks | | Number of blocks scheduled for replication | -| PendingDeletionBlocks | | Number of blocks awaiting deletion | -| ExcessBlocks | | Number of excess blocks | -| PostponedMisreplicatedBlocks| | Number of misreplicated blocks postponed for processing | -| NumLiveDataNodes | | Number of live data nodes in the cluster | -| NumDeadDataNodes | | Number of data nodes marked as dead | -| NumDecomLiveDataNodes | | Number of decommissioned live nodes | -| NumDecomDeadDataNodes | | Number of decommissioned dead nodes | -| NumDecommissioningDataNodes | | Number of nodes currently being decommissioned | -| TransactionsSinceLastCheckpoint | | Number of transactions since the last checkpoint | -| LastCheckpointTime | | Time of the last checkpoint | -| PendingDataNodeMessageCount| | Number of DATANODE requests queued in the standby namenode | +| Metric Name | Metric Unit | Metric Description | +|---------------------------------|-------------|------------------------------------------------------------| +| CapacityTotal | | Total cluster storage capacity | +| CapacityTotalGB | GB | Total cluster storage capacity | +| CapacityUsed | | Used cluster storage capacity | +| CapacityUsedGB | GB | Used cluster storage capacity | +| CapacityRemaining | | Remaining cluster storage capacity | +| CapacityRemainingGB | GB | Remaining cluster storage capacity | +| CapacityUsedNonDFS | | Non-HDFS usage of cluster capacity | +| TotalLoad | | Total client connections in the cluster | +| FilesTotal | | Total number of files in the cluster | +| BlocksTotal | | Total number of BLOCKs | +| PendingReplicationBlocks | | Number of blocks awaiting replication | +| UnderReplicatedBlocks | | Number of blocks with insufficient replicas | +| CorruptBlocks | | Number of corrupt blocks | +| ScheduledReplicationBlocks | | Number of blocks scheduled for replication | +| PendingDeletionBlocks | | Number of blocks awaiting deletion | +| ExcessBlocks | | Number of excess blocks | +| PostponedMisreplicatedBlocks | | Number of misreplicated blocks postponed for processing | +| NumLiveDataNodes | | Number of live data nodes in the cluster | +| NumDeadDataNodes | | Number of data nodes marked as dead | +| NumDecomLiveDataNodes | | Number of decommissioned live nodes | +| NumDecomDeadDataNodes | | Number of decommissioned dead nodes | +| NumDecommissioningDataNodes | | Number of nodes currently being decommissioned | +| TransactionsSinceLastCheckpoint | | Number of transactions since the last checkpoint | +| LastCheckpointTime | | Time of the last checkpoint | +| PendingDataNodeMessageCount | | Number of DATANODE requests queued in the standby namenode | #### Metric Set: RPC -| Metric Name | Metric Unit | Metric Description | -| ------------------------- | ----------- | -------------------------- | -| ReceivedBytes | | Data receiving rate | -| SentBytes | | Data sending rate | -| RpcQueueTimeNumOps | | RPC call rate | +| Metric Name | Metric Unit | Metric Description | +|--------------------|-------------|---------------------| +| ReceivedBytes | | Data receiving rate | +| SentBytes | | Data sending rate | +| RpcQueueTimeNumOps | | RPC call rate | #### Metric Set: runtime -| Metric Name | Metric Unit | Metric Description | -| ------------------------- | ----------- | ------------------- | -| StartTime | | Start time | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|--------------------| +| StartTime | | Start time | #### Metric Set: JvmMetrics -| Metric Name | Metric Unit | Metric Description | -| ------------------------- | ----------- | ------------------- | -| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | -| MemNonHeapCommittedM | MB | Committed NonHeapMemory by JVM | -| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | -| MemHeapCommittedM | MB | Committed HeapMemory by JVM | -| MemHeapMaxM | MB | Maximum HeapMemory configured for JVM | -| MemMaxM | MB | Maximum memory that can be used by JVM | -| GcCountParNew | Count | Number of ParNew GC events | -| GcTimeMillisParNew | Milliseconds| Time spent in ParNew GC | -| GcCountConcurrentMarkSweep| Count | Number of ConcurrentMarkSweep GC events| -| GcTimeMillisConcurrentMarkSweep | Milliseconds | Time spent in ConcurrentMarkSweep GC | -| GcCount | Count | Total number of GC events | -| GcTimeMillis | Milliseconds| Total time spent in GC events | -| ThreadsRunnable | Count | Number of threads in RUNNABLE state | -| ThreadsBlocked | Count | Number of threads in BLOCKED state | -| ThreadsWaiting | Count | Number of threads in WAITING state | -| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state| +| Metric Name | Metric Unit | Metric Description | +|---------------------------------|--------------|------------------------------------------| +| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | +| MemNonHeapCommittedM | MB | Committed NonHeapMemory by JVM | +| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | +| MemHeapCommittedM | MB | Committed HeapMemory by JVM | +| MemHeapMaxM | MB | Maximum HeapMemory configured for JVM | +| MemMaxM | MB | Maximum memory that can be used by JVM | +| GcCountParNew | Count | Number of ParNew GC events | +| GcTimeMillisParNew | Milliseconds | Time spent in ParNew GC | +| GcCountConcurrentMarkSweep | Count | Number of ConcurrentMarkSweep GC events | +| GcTimeMillisConcurrentMarkSweep | Milliseconds | Time spent in ConcurrentMarkSweep GC | +| GcCount | Count | Total number of GC events | +| GcTimeMillis | Milliseconds | Total time spent in GC events | +| ThreadsRunnable | Count | Number of threads in RUNNABLE state | +| ThreadsBlocked | Count | Number of threads in BLOCKED state | +| ThreadsWaiting | Count | Number of threads in WAITING state | +| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | + diff --git a/home/docs/help/hive.md b/home/docs/help/hive.md index ec0d7dee398..806969c2e7c 100644 --- a/home/docs/help/hive.md +++ b/home/docs/help/hive.md @@ -16,6 +16,7 @@ If you want to monitor information in `Apache Hive` with this monitoring type, y ```shell hive --service metastore & ``` + **2. Enable hive server2:** ```shell @@ -24,55 +25,53 @@ 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 | +| 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 | +| 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 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 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 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. | +| 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. | - - +| used | MB | The amount of memory currently being used by the memory pool. | diff --git a/home/docs/help/http_sd.md b/home/docs/help/http_sd.md index 3278936d66d..6b8de487555 100644 --- a/home/docs/help/http_sd.md +++ b/home/docs/help/http_sd.md @@ -16,39 +16,37 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito > We currently support for `Consul` and `Nacos`. 2. Add http_sd monitor and enter necessary info about **Register center** on Hertzbeat, such as host, port and so on. - 3. Click **OK** # Configuration parameter -| Parameter name | Parameter help description | -| --------------------- | ------------------------------------------------------------ | -| Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Task name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Register center | -| Discovery Client Type | Select one Register center that you want to monitor | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Parameter name | Parameter help description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by Register center | +| Discovery Client Type | Select one Register center that you want to monitor | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | # Collection Metrics ## Metrics Set：server -| Metric name | Metric unit | Metric help description | -| ------------- | ----------- | ----------------------- | +| Metric name | Metric unit | Metric help description | +|---------------|-------------|-------------------------| | Address | | | | Port | | | | Response Time | ms | | ## Metrics Set：service -| Metric name | Metric unit | Metric help description | -| ------------- | ----------- | -------------------------------- | +| Metric name | Metric unit | Metric help description | +|---------------|-------------|----------------------------------| | Service Id | | | | Service Name | | | | Address | | | | Port | | | | Health Status | | Current health status of service | - diff --git a/home/docs/help/huawei_switch.md b/home/docs/help/huawei_switch.md index 8217ff554b8..902c0596965 100644 --- a/home/docs/help/huawei_switch.md +++ b/home/docs/help/huawei_switch.md @@ -1,53 +1,54 @@ ---- -id: huawei_switch -title: Monitoring：Huawei switch -sidebar_label: Huawei switch -keywords: [ open source monitoring tool, network monitoring, Huawei switch ] ---- - -> Collect and monitor the general indicators (availability, system information, port traffic, etc.) of Huawei switches. - -**Protocol Use: SNMP** - -### Configuration parameter - -| Parameter name | Parameter help description | -|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Task Name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port of SNMP. The default is 161 | -| SNMP Version | SNMP version to use | -| SNMP Community | Used in SNMP v1 and SNMP v2c, used to complete authentication in SNMP Agent, in string form. Group name includes "read" and "write", when performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. When performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. | -| SNMP username | For SNMP v3, MSG username | -| SNMP contextName | For SNMP v3, used to determine the MIB view of the Context EngineID to the managed device | -| SNMP authPassword | For SNMP v3, SNMP authentication passwords | -| authPassword Encryption | For SNMP v3, SNMP authentication algorithm | -| SNMP privPassphrase | For SNMP v3, SNMP encrypted passwords | -| privPassword Encryption | For SNMP v3, SNMP encrypted algorithm | -| Timeout | Set the timeout time when querying unresponsive data, in milliseconds, the default is 6000 milliseconds | -| Intervals | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Description | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -Since there are too many metrics that can be queried on Huawei switches, detailed metrics can be queried -on [Huawei MIB Query Platform](https://info.support.huawei.com/info-finder/tool/en/enterprise/mib). - -This document only introduces the monitoring indicators queried in the monitor template. - -#### Metric set: huawei_core - -| Metric Name | Metric Unit | Metric Help Description | -|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ifIndex | none | Interface index. This value is greater than zero and globally unique. | -| ifDescr | none | A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the interface hardware/software. | -| ifMtu | octets | The size of the largest packet which can be sent/received on the interface. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface. | -| ifSpeed | bit/s | An estimate of the interface's current bandwidth. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interace's speed. For a sub-layer which has no concept of bandwidth, this object should be zero. | -| ifInOctets | octets | The total number of octets received on the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifInDiscards | none | The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifInErrors | none | For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifOutOctets | octets | The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifOutDiscards | none | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifOutErrors | none | For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifAdminStatus | none | The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state). | -| ifOperStatus | none | The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If ifAdminStatus is down(2) then ifOperStatus should be down(2). If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components. | +--- +id: huawei_switch +title: Monitoring：Huawei switch +sidebar_label: Huawei switch +keywords: [ open source monitoring tool, network monitoring, Huawei switch ] +--- + +> Collect and monitor the general indicators (availability, system information, port traffic, etc.) of Huawei switches. + +**Protocol Use: SNMP** + +### Configuration parameter + +| Parameter name | Parameter help description | +|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task Name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port of SNMP. The default is 161 | +| SNMP Version | SNMP version to use | +| SNMP Community | Used in SNMP v1 and SNMP v2c, used to complete authentication in SNMP Agent, in string form. Group name includes "read" and "write", when performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. When performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. | +| SNMP username | For SNMP v3, MSG username | +| SNMP contextName | For SNMP v3, used to determine the MIB view of the Context EngineID to the managed device | +| SNMP authPassword | For SNMP v3, SNMP authentication passwords | +| authPassword Encryption | For SNMP v3, SNMP authentication algorithm | +| SNMP privPassphrase | For SNMP v3, SNMP encrypted passwords | +| privPassword Encryption | For SNMP v3, SNMP encrypted algorithm | +| Timeout | Set the timeout time when querying unresponsive data, in milliseconds, the default is 6000 milliseconds | +| Intervals | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Description | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metric + +Since there are too many metrics that can be queried on Huawei switches, detailed metrics can be queried +on [Huawei MIB Query Platform](https://info.support.huawei.com/info-finder/tool/en/enterprise/mib). + +This document only introduces the monitoring indicators queried in the monitor template. + +#### Metric set: huawei_core + +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ifIndex | none | Interface index. This value is greater than zero and globally unique. | +| ifDescr | none | A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the interface hardware/software. | +| ifMtu | octets | The size of the largest packet which can be sent/received on the interface. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface. | +| ifSpeed | bit/s | An estimate of the interface's current bandwidth. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interace's speed. For a sub-layer which has no concept of bandwidth, this object should be zero. | +| ifInOctets | octets | The total number of octets received on the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifInDiscards | none | The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifInErrors | none | For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutOctets | octets | The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutDiscards | none | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutErrors | none | For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifAdminStatus | none | The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state). | +| ifOperStatus | none | The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If ifAdminStatus is down(2) then ifOperStatus should be down(2). If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components. | + diff --git a/home/docs/help/hugegraph.md b/home/docs/help/hugegraph.md index 4fca13f4e00..66b0574aab7 100644 --- a/home/docs/help/hugegraph.md +++ b/home/docs/help/hugegraph.md @@ -4,6 +4,7 @@ title: Monitoring HugeGraph Monitoring sidebar_label: Apache HugeGraph keywords: [Open Source Monitoring System, Open Source Database Monitoring, HugeGraph Monitoring] --- + > Collect and monitor the general performance metrics of HugeGraph **Protocol used: HTTP** @@ -14,137 +15,127 @@ Check the `rest-server.properties` file to obtain the value of the `restserver_p ## Configuration Parameters - -| Parameter Name | Parameter Description | -|------------------|--------------------------------------------------------| -| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). | -| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter | -| Enable SSL | Enable SSL usage | -| Base Path | Base path, default is: /metrics, usually does not need to be modified | -| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | -| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds | -| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful | -| Description | Additional identification and description of this monitoring, users can add information here | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). | +| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter | +| Enable SSL | Enable SSL usage | +| Base Path | Base path, default is: /metrics, usually does not need to be modified | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds | +| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful | +| Description | Additional identification and description of this monitoring, users can add information here | ### Metrics Collection #### Metric Set: gauges -| Metric Name | Metric Unit | Metric Description | -| ------------------------------------ | -------- | --------------------------------- | -| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph | -| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data | -| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache | -| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache | -| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph | -| instances | NONE | Indicates the number of currently running HugeGraph instances| -| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph | -| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data | -| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache| -| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache| -| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph | -| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph | -| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data | -| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache| -| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache| -| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph | -| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph | -| token-hugegraph-expire | NONE | Indicates the expiration time of token data | -| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache | -| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache | -| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph | -| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph | -| users-hugegraph-expire | NONE | Indicates the expiration time of user data | -| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache | -| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache | -| users-hugegraph-size | NONE | Indicates the number of users in the current graph | -| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords | -| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data | -| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache| -| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache| -| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph | -| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph | -| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data | -| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache | -| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache | -| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph | -| batch-write-threads | NONE | Indicates the number of threads for batch write operations | -| max-write-threads | NONE | Indicates the maximum number of threads for write operations | -| pending-tasks | NONE | Indicates the number of pending tasks | -| workers | NONE | Indicates the current number of worker threads | -| average-load-penalty | NONE | Indicates the average load penalty | -| estimated-size | NONE | Indicates the estimated data size | -| eviction-count | NONE | Indicates the number of evicted data entries | -| eviction-weight | NONE | Indicates the weight of evicted data | -| hit-count | NONE | Indicates the total cache hits | -| hit-rate | NONE | Indicates the cache hit rate | -| load-count | NONE | Indicates the number of data loads | -| load-failure-count | NONE | Indicates the number of data load failures | -| load-failure-rate | NONE | Indicates the data load failure rate | -| load-success-count | NONE | Indicates the number of successful data loads | -| long-run-compilation-count | NONE | Indicates the number of long-running compilations | -| miss-count | NONE | Indicates the total cache misses | -| miss-rate | NONE | Indicates the cache miss rate | -| request-count | NONE | Indicates the total request count | -| total-load-time | NONE | Indicates the total data load time | -| sessions | NONE | Indicates the current number of active sessions | - - - +| Metric Name | Metric Unit | Metric Description | +|--------------------------------|-------------|----------------------------------------------------------------| +| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph | +| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data | +| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache | +| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache | +| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph | +| instances | NONE | Indicates the number of currently running HugeGraph instances | +| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph | +| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data | +| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache | +| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache | +| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph | +| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph | +| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data | +| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache | +| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache | +| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph | +| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph | +| token-hugegraph-expire | NONE | Indicates the expiration time of token data | +| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache | +| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache | +| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph | +| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph | +| users-hugegraph-expire | NONE | Indicates the expiration time of user data | +| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache | +| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache | +| users-hugegraph-size | NONE | Indicates the number of users in the current graph | +| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords | +| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data | +| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache | +| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache | +| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph | +| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph | +| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data | +| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache | +| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache | +| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph | +| batch-write-threads | NONE | Indicates the number of threads for batch write operations | +| max-write-threads | NONE | Indicates the maximum number of threads for write operations | +| pending-tasks | NONE | Indicates the number of pending tasks | +| workers | NONE | Indicates the current number of worker threads | +| average-load-penalty | NONE | Indicates the average load penalty | +| estimated-size | NONE | Indicates the estimated data size | +| eviction-count | NONE | Indicates the number of evicted data entries | +| eviction-weight | NONE | Indicates the weight of evicted data | +| hit-count | NONE | Indicates the total cache hits | +| hit-rate | NONE | Indicates the cache hit rate | +| load-count | NONE | Indicates the number of data loads | +| load-failure-count | NONE | Indicates the number of data load failures | +| load-failure-rate | NONE | Indicates the data load failure rate | +| load-success-count | NONE | Indicates the number of successful data loads | +| long-run-compilation-count | NONE | Indicates the number of long-running compilations | +| miss-count | NONE | Indicates the total cache misses | +| miss-rate | NONE | Indicates the cache miss rate | +| request-count | NONE | Indicates the total request count | +| total-load-time | NONE | Indicates the total data load time | +| sessions | NONE | Indicates the current number of active sessions | #### Metric Set: counters - - -| Metric Name | Metric Unit | Metric Description | -| --------------------------------------------- | -------- | ---------------------------------------- | -| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests | -| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests | -| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico | -| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico | -| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources | -| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources | -| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources | -| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs | -| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs | -| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics | -| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | -| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics | -| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | -| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges | -| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges | - - - +| Metric Name | Metric Unit | Metric Description | +|-----------------------------------------------------|-------------|--------------------------------------------------------------------------------| +| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests | +| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests | +| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico | +| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico | +| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources | +| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources | +| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources | +| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs | +| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs | +| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics | +| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | +| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics | +| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | +| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges | +| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges | #### Metric Set: system +| Metric Name | Metric Unit | Metric Description | +|---------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------| +| mem | NONE | Indicates the total memory of the system | +| mem_total | NONE | Indicates the total memory of the system (same as mem) | +| mem_used | NONE | Indicates the currently used memory of the system | +| mem_free | NONE | Indicates the free memory of the system | +| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) | +| processors | NONE | Indicates the number of processors in the system | +| uptime | NONE | Indicates the system uptime, i.e., the time since booting | +| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness | +| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM | +| heap_init | NONE | Indicates the initial size of JVM heap memory | +| heap_used | NONE | Indicates the currently used JVM heap memory size | +| heap_max | NONE | Indicates the maximum available size of JVM heap memory | +| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory | +| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory | +| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size | +| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory | +| thread_peak | NONE | Indicates the peak number of threads since JVM startup | +| thread_daemon | NONE | Indicates the current number of active daemon threads | +| thread_total_started | NONE | Indicates the total number of threads started since JVM startup | +| thread_count | NONE | Indicates the current number of active threads | +| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector | +| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector | +| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector | +| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector | +| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) | - -| Metric Name | Metric Unit | Metric Description | -| --------------------------------------------- | -------- | -------------------------------------------------- | -| mem | NONE | Indicates the total memory of the system | -| mem_total | NONE | Indicates the total memory of the system (same as mem) | -| mem_used | NONE | Indicates the currently used memory of the system | -| mem_free | NONE | Indicates the free memory of the system | -| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) | -| processors | NONE | Indicates the number of processors in the system | -| uptime | NONE | Indicates the system uptime, i.e., the time since booting | -| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness | -| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM | -| heap_init | NONE | Indicates the initial size of JVM heap memory | -| heap_used | NONE | Indicates the currently used JVM heap memory size | -| heap_max | NONE | Indicates the maximum available size of JVM heap memory | -| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory | -| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory | -| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size | -| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory | -| thread_peak | NONE | Indicates the peak number of threads since JVM startup | -| thread_daemon | NONE | Indicates the current number of active daemon threads | -| thread_total_started | NONE | Indicates the total number of threads started since JVM startup | -| thread_count | NONE | Indicates the current number of active threads | -| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector | -| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector | -| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector | -| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector | -| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) | \ No newline at end of file diff --git a/home/docs/help/influxdb.md b/home/docs/help/influxdb.md index cf3d838e796..92c5da380ef 100644 --- a/home/docs/help/influxdb.md +++ b/home/docs/help/influxdb.md @@ -7,61 +7,60 @@ keywords: [open source monitoring system, open source database monitoring, Influ ### Configuration Parameters -| Parameter Name | Parameter Description | -| -------------- | -------------------------------------------------------- | -| Monitor Host | The IPv4, IPv6, or domain name of the target being monitored. Note⚠️: Do not include the protocol header (e.g., https://, http://). | -| Task Name | A unique identifier for this monitoring task. | -| Port | The port on which the database is exposed. Default is 8086. | -| URL | The database connection URL, usually constructed from the host. No need to add it separately. | -| Collection Interval | The interval at which data is collected during monitoring, in seconds. The minimum interval that can be set is 30 seconds. | -| Probe Enabled | Whether to perform a probe check for monitoring availability before adding or modifying the monitoring task. | -| Description | Additional notes and remarks about this monitoring task. Users can provide information and descriptions here. | +| Parameter Name | Parameter Description | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | The IPv4, IPv6, or domain name of the target being monitored. Note⚠️: Do not include the protocol header (e.g., https://, http://). | +| Task Name | A unique identifier for this monitoring task. | +| Port | The port on which the database is exposed. Default is 8086. | +| URL | The database connection URL, usually constructed from the host. No need to add it separately. | +| Collection Interval | The interval at which data is collected during monitoring, in seconds. The minimum interval that can be set is 30 seconds. | +| Probe Enabled | Whether to perform a probe check for monitoring availability before adding or modifying the monitoring task. | +| Description | Additional notes and remarks about this monitoring task. Users can provide information and descriptions here. | ### Collected Metrics #### Metric Set: influxdb_info | Metric Name | Metric Unit | Metric Description | -|------------| ----------- |--------| -| build_date | N/A | Creation date | -| os | N/A | Operating system | -| cpus | N/A | CPUs | -| version | N/A | Version number | +|-------------|-------------|--------------------| +| build_date | N/A | Creation date | +| os | N/A | Operating system | +| cpus | N/A | CPUs | +| version | N/A | Version number | #### Metric Set: http_api_request_duration_seconds -| Metric Name | Metric Unit | Metric Description | -|---------------|------|---------| -| handler | N/A | Handler | -| path | N/A | Path | -| response_code | N/A | Response code | -| method | N/A | Request method | -| user_agent | N/A | User agent | -| status | N/A | Status | +| Metric Name | Metric Unit | Metric Description | +|---------------|-------------|--------------------| +| handler | N/A | Handler | +| path | N/A | Path | +| response_code | N/A | Response code | +| method | N/A | Request method | +| user_agent | N/A | User agent | +| status | N/A | Status | #### Metric Set: storage_compactions_queued -| Metric Name | Metric Unit | Metric Description | -|---------------------------------|------|------------| -| bucket | N/A | Storage bucket | -| engine | N/A | Engine type | -| id | N/A | Identifier | -| level | N/A | Level | -| path | N/A | Data file path | - +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|--------------------| +| bucket | N/A | Storage bucket | +| engine | N/A | Engine type | +| id | N/A | Identifier | +| level | N/A | Level | +| path | N/A | Data file path | #### Metric Set: http_write_request_bytes -| Metric Name | Metric Unit | Metric Description | -| ----------- |------|--------| -| endpoint | N/A | Endpoint | -| org_id | N/A | Organization identifier | -| status | N/A | Status | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|-------------------------| +| endpoint | N/A | Endpoint | +| org_id | N/A | Organization identifier | +| status | N/A | Status | #### Metric Set: qc_requests_total -| Metric Name | Metric Unit | Metric Description | -| ----------- |------|--------| -| result | N/A | Result | -| org | N/A | Organization identifier | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|-------------------------| +| result | N/A | Result | +| org | N/A | Organization identifier | diff --git a/home/docs/help/influxdb_promql.md b/home/docs/help/influxdb_promql.md index fcef4b4acff..afed14cad7a 100644 --- a/home/docs/help/influxdb_promql.md +++ b/home/docs/help/influxdb_promql.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). | | Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: basic_influxdb_memstats_alloc -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: influxdb_database_numMeasurements -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | job | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -46,7 +46,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: influxdb_query_rate_seconds -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | @@ -54,8 +54,9 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: influxdb_queryExecutor_queriesFinished_10s -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | | value | None | Metric value | + diff --git a/home/docs/help/iotdb.md b/home/docs/help/iotdb.md index 0e4dcad9912..bec827feb73 100644 --- a/home/docs/help/iotdb.md +++ b/home/docs/help/iotdb.md @@ -61,33 +61,33 @@ predefinedMetrics: #### 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 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 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 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 | +| 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 @@ -114,7 +114,8 @@ predefinedMetrics: #### Metric collection: thrift_connections -| Metric Name | Metric Unit | Metric Help Description | -|-------|------|-------------| -| name | None | name | -| connection | none | thrift current connection number | +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|----------------------------------| +| name | None | name | +| connection | none | thrift current connection number | + diff --git a/home/docs/help/issue.md b/home/docs/help/issue.md index c3dffd147be..a48e84cfd4e 100644 --- a/home/docs/help/issue.md +++ b/home/docs/help/issue.md @@ -1,49 +1,58 @@ --- id: issue title: Common issues -sidebar_label: Common issues +sidebar_label: Common issues --- -### Monitoring 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 +1. **Page feedback：monitor.host: Monitoring Host must be ipv4, ipv6 or domain name** -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) +> 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 hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。 + > The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened. > When you install HertzBeat via DockerDocker root is enabled by default. No such problem. -> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address - -### Docker Deployment common issues +### Docker Deployment common issues 1. **MYSQL, TDENGINE and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** -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. + 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 .....` +> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy，visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issues： + Please refer to the following points to troubleshoot issues： + > one：Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed. -> two：Check whether dependent service, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. -> > three：`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. +> 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** -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. +> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. ### Package Deployment common issues 1. **According to the process deploy，visit http://ip:1157/ no interface** Please refer to the following points to troubleshoot issues: + > one：Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed. > two：Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`. > three： Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. 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. +> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. + diff --git a/home/docs/help/jetty.md b/home/docs/help/jetty.md index 3e5230aa9d0..6e069553dba 100644 --- a/home/docs/help/jetty.md +++ b/home/docs/help/jetty.md @@ -23,6 +23,7 @@ keywords: [open source monitoring tool, open source jetty web server monitoring 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. @@ -50,7 +51,7 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -73,19 +74,17 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` | max | kb | max size | | used | kb | used size | - #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | diff --git a/home/docs/help/jvm.md b/home/docs/help/jvm.md index 95b1545fffc..3b47e0e7a8a 100644 --- a/home/docs/help/jvm.md +++ b/home/docs/help/jvm.md @@ -24,7 +24,7 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -58,16 +58,15 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -76,4 +75,3 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/kafka.md b/home/docs/help/kafka.md index 067cabef0e9..f86913733b1 100644 --- a/home/docs/help/kafka.md +++ b/home/docs/help/kafka.md @@ -27,70 +27,64 @@ 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 | +| 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 | - +| 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 | +| 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 | - +| 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 | +| 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 | - - - +| 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/docs/help/kafka_promql.md b/home/docs/help/kafka_promql.md index e88f6eb0342..ea358d0de8d 100644 --- a/home/docs/help/kafka_promql.md +++ b/home/docs/help/kafka_promql.md @@ -16,7 +16,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka ### Configuration Parameters -| Parameter Name | Parameter Description | +| Parameter Name | Parameter Description | |---------------------|----------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). | | Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. | @@ -35,7 +35,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka #### Metric Set: kafka_brokers -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | \_\_name__ | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -44,7 +44,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka #### Metric Set: kafka_topic_partitions -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | \_\_name__ | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -53,7 +53,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka #### Metric Set: kafka_server_brokertopicmetrics_bytesinpersec -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | \_\_name__ | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -64,3 +64,4 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka 1. If Kafka is enabled with JMX monitoring, you can use [Kafka](kafka) Monitoring. 2. If Kafka cluster deploys kafka_exporter to expose monitoring metrics, you can refer to [Prometheus task](prometheus) to configure the Prometheus collection task to monitor kafka. + diff --git a/home/docs/help/kubernetes.md b/home/docs/help/kubernetes.md index 8e10896c6d1..45adda576fc 100644 --- a/home/docs/help/kubernetes.md +++ b/home/docs/help/kubernetes.md @@ -28,6 +28,7 @@ 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 @@ -36,59 +37,60 @@ 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 | +| 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 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 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 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 | +| 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/docs/help/linux.md b/home/docs/help/linux.md index 05e3405ff6e..6c22028114c 100644 --- a/home/docs/help/linux.md +++ b/home/docs/help/linux.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source linux monitoring tool, monit ### 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 | +| 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 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 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 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 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 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 | +| 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/docs/help/mariadb.md b/home/docs/help/mariadb.md index e72668fe791..374e6e6a081 100644 --- a/home/docs/help/mariadb.md +++ b/home/docs/help/mariadb.md @@ -9,49 +9,46 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - - +| 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/docs/help/memcached.md b/home/docs/help/memcached.md index 5d89ce0977b..920da021e6b 100644 --- a/home/docs/help/memcached.md +++ b/home/docs/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 You need to use the stats command to view the parameters that your memcache can monitor ``` -### +### **1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. @@ -36,7 +36,7 @@ STAT version 1.4.15 ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -49,7 +49,7 @@ STAT version 1.4.15 #### Metrics Set：server_info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|---------------------------------------------------| | pid | | Memcache server process ID | | uptime | s | The number of seconds the server has been running | @@ -66,4 +66,5 @@ STAT version 1.4.15 | cmd_set | | Set command request count | | cmd_flush | | Flush command request count | | get_misses | | Get command misses | -| delete_misses | | Delete command misses | \ No newline at end of file +| delete_misses | | Delete command misses | + diff --git a/home/docs/help/mongodb.md b/home/docs/help/mongodb.md index 4a2951ec23c..9c536e73d7a 100644 --- a/home/docs/help/mongodb.md +++ b/home/docs/help/mongodb.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |------------------------|-------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -27,7 +27,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:Build Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|-----------------------------------------------------------------------------------------| | version | none | The version number of the MongoDB server. | | gitVersion | none | The Git version of the MongoDB codebase. | @@ -39,7 +39,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:Server Document -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-----------------------------------| | deleted | none | The number of documents deleted. | | inserted | none | The number of documents inserted. | @@ -48,21 +48,21 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:Server Operation -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |----------------|-------------|------------------------------------------------------------------| | scanAndOrder | none | The number of times a query required both scanning and ordering. | | writeConflicts | none | The number of write conflicts that occurred. | #### Metric set: Max Connections -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|--------------------------------------------| | deletedDocuments | none | Number of deleted documents. | | passes | none | Total number of passes for TTL operations. | #### Metric set:System Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|------------------------------------------------------| | currentTime | none | Current system time. | | hostname | none | Hostname of the server. | @@ -75,7 +75,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:OS Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|----------------------------------| | type | none | Type of the operating system. | | name | none | Name of the operating system. | @@ -83,7 +83,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set：Extra Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-----------------|-------------|--------------------------------------------------------| | versionString | none | String describing the version of the operating system. | | libcVersion | none | Version of the C standard library (libc). | diff --git a/home/docs/help/mysql.md b/home/docs/help/mysql.md index 3f07be99380..dca64b3f9f0 100644 --- a/home/docs/help/mysql.md +++ b/home/docs/help/mysql.md @@ -7,9 +7,9 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo > Collect and monitor the general performance Metrics of MySQL database. Support MYSQL5+. -### Configuration parameter +### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -27,31 +27,28 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo #### 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 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 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 | - - +| 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/docs/help/nacos.md b/home/docs/help/nacos.md index 1dbc4113c5d..4de3661c17b 100644 --- a/home/docs/help/nacos.md +++ b/home/docs/help/nacos.md @@ -1,93 +1,95 @@ ---- -id: nacos -title: Monitoring：Nacos Server monitoring -sidebar_label: Nacos Server -keywords: [open source monitoring tool, open source middleware monitoring tool, monitoring Nacos Server metrics] ---- - -> Hertzbeat monitors metrics of the Nacos Server by calling the Nacos Metrics Api. - -### PreRequisites - -#### Deploy Nacos cluster to expose metrics data - -1. Deploy the Nacos cluster according to [deployment document](https://nacos.io/en-us/docs/deployment.html). -2. Configure the application. properties file to expose metrics data. -``` -management.endpoints.web.exposure.include=* -``` -3. Access ```{ip}:8848/nacos/actuator/prometheus``` to see if metrics data can be accessed. - -More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-guide.html). - -### Configuration parameter - -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Target name | Identify the name of this monitoring. The name needs to be unique | -| Nacos Port | Port provided by the Nacos Server. The default is 8848 | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - -### Collection Metric - -#### Metric set：jvm - -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| system_cpu_usage | none | cpu usage | -| system_load_average_1m | none | load | -| jvm_memory_used_bytes | byte | jvm memory used | -| jvm_memory_max_bytes | byte | jvm max memory | -| jvm_gc_pause_seconds_count | none | gc count | -| jvm_gc_pause_seconds_sum | second | gc time | -| jvm_threads_daemon | none | jvm threads count | - -#### Metric set：Nacos - -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| http_server_requests_seconds_count | second | http requests count | -| http_server_requests_seconds_sum | second | http requests time | -| nacos_timer_seconds_sum | second | Nacos config notify time | -| nacos_timer_seconds_count | none | Nacos config notify count | -| nacos_monitor{name='longPolling'} | none | Nacos config connection count | -| nacos_monitor{name='configCount'} | none | Nacos configuration file count | -| nacos_monitor{name='dumpTask'} | none | Nacos config dump task count | -| nacos_monitor{name='notifyTask'} | none | Nacos config notify task count | -| nacos_monitor{name='getConfig'} | none | Nacos config read configuration count | -| nacos_monitor{name='publish'} | none | Nacos config update configuration count | -| nacos_monitor{name='ipCount'} | none | Nacos naming ip count | -| nacos_monitor{name='domCount'} | none | Nacos naming domain count(1.x version) | -| nacos_monitor{name='serviceCount'} | none | Nacos naming domain count(2.x version) | -| nacos_monitor{name='failedPush'} | none | Nacos naming push fail count | -| nacos_monitor{name='avgPushCost'} | second | Nacos naming push cost time(average) | -| nacos_monitor{name='leaderStatus'} | none | Nacos naming if node is leader | -| nacos_monitor{name='maxPushCost'} | second | Nacos naming push cost time(max) | -| nacos_monitor{name='mysqlhealthCheck'} | none | Nacos naming mysql health check count | -| nacos_monitor{name='httpHealthCheck'} | none | Nacos naming http health check count | -| nacos_monitor{name='tcpHealthCheck'} | none | Nacos naming tcp health check count | - -#### Metric set：Nacos exception - -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| nacos_exception_total{name='db'} | none | database exception | -| nacos_exception_total{name='configNotify'} | none | Nacos config notify exception | -| nacos_exception_total{name='unhealth'} | none | Nacos config server health check exception | -| nacos_exception_total{name='disk'} | none | Nacos naming write disk exception | -| nacos_exception_total{name='leaderSendBeatFailed'} | none | Nacos naming leader send heart beat fail count | -| nacos_exception_total{name='illegalArgument'} | none | request argument illegal count | -| nacos_exception_total{name='nacos'} | none | Nacos inner exception | - -#### Metric set：client - -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| nacos_monitor{name='subServiceCount'} | none | subscribed services count | -| nacos_monitor{name='pubServiceCount'} | none | published services count | -| nacos_monitor{name='configListenSize'} | none | listened configuration file count | -| nacos_client_request_seconds_count | none | request count | -| nacos_client_request_seconds_sum | second | request time | - \ No newline at end of file +--- +id: nacos +title: Monitoring：Nacos Server monitoring +sidebar_label: Nacos Server +keywords: [open source monitoring tool, open source middleware monitoring tool, monitoring Nacos Server metrics] +--- + +> Hertzbeat monitors metrics of the Nacos Server by calling the Nacos Metrics Api. + +### PreRequisites + +#### Deploy Nacos cluster to expose metrics data + +1. Deploy the Nacos cluster according to [deployment document](https://nacos.io/en-us/docs/deployment.html). +2. Configure the application. properties file to expose metrics data. + +``` +management.endpoints.web.exposure.include=* +``` + +3. Access ```{ip}:8848/nacos/actuator/prometheus``` to see if metrics data can be accessed. + +More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-guide.html). + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|-------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Target name | Identify the name of this monitoring. The name needs to be unique | +| Nacos Port | Port provided by the Nacos Server. The default is 8848 | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metric + +#### Metric set：jvm + +| Metric name | Metric unit | Metric help description | +|----------------------------|-------------|-------------------------| +| system_cpu_usage | none | cpu usage | +| system_load_average_1m | none | load | +| jvm_memory_used_bytes | byte | jvm memory used | +| jvm_memory_max_bytes | byte | jvm max memory | +| jvm_gc_pause_seconds_count | none | gc count | +| jvm_gc_pause_seconds_sum | second | gc time | +| jvm_threads_daemon | none | jvm threads count | + +#### Metric set：Nacos + +| Metric name | Metric unit | Metric help description | +|----------------------------------------|-------------|-----------------------------------------| +| http_server_requests_seconds_count | second | http requests count | +| http_server_requests_seconds_sum | second | http requests time | +| nacos_timer_seconds_sum | second | Nacos config notify time | +| nacos_timer_seconds_count | none | Nacos config notify count | +| nacos_monitor{name='longPolling'} | none | Nacos config connection count | +| nacos_monitor{name='configCount'} | none | Nacos configuration file count | +| nacos_monitor{name='dumpTask'} | none | Nacos config dump task count | +| nacos_monitor{name='notifyTask'} | none | Nacos config notify task count | +| nacos_monitor{name='getConfig'} | none | Nacos config read configuration count | +| nacos_monitor{name='publish'} | none | Nacos config update configuration count | +| nacos_monitor{name='ipCount'} | none | Nacos naming ip count | +| nacos_monitor{name='domCount'} | none | Nacos naming domain count(1.x version) | +| nacos_monitor{name='serviceCount'} | none | Nacos naming domain count(2.x version) | +| nacos_monitor{name='failedPush'} | none | Nacos naming push fail count | +| nacos_monitor{name='avgPushCost'} | second | Nacos naming push cost time(average) | +| nacos_monitor{name='leaderStatus'} | none | Nacos naming if node is leader | +| nacos_monitor{name='maxPushCost'} | second | Nacos naming push cost time(max) | +| nacos_monitor{name='mysqlhealthCheck'} | none | Nacos naming mysql health check count | +| nacos_monitor{name='httpHealthCheck'} | none | Nacos naming http health check count | +| nacos_monitor{name='tcpHealthCheck'} | none | Nacos naming tcp health check count | + +#### Metric set：Nacos exception + +| Metric name | Metric unit | Metric help description | +|----------------------------------------------------|-------------|------------------------------------------------| +| nacos_exception_total{name='db'} | none | database exception | +| nacos_exception_total{name='configNotify'} | none | Nacos config notify exception | +| nacos_exception_total{name='unhealth'} | none | Nacos config server health check exception | +| nacos_exception_total{name='disk'} | none | Nacos naming write disk exception | +| nacos_exception_total{name='leaderSendBeatFailed'} | none | Nacos naming leader send heart beat fail count | +| nacos_exception_total{name='illegalArgument'} | none | request argument illegal count | +| nacos_exception_total{name='nacos'} | none | Nacos inner exception | + +#### Metric set：client + +| Metric name | Metric unit | Metric help description | +|----------------------------------------|-------------|-----------------------------------| +| nacos_monitor{name='subServiceCount'} | none | subscribed services count | +| nacos_monitor{name='pubServiceCount'} | none | published services count | +| nacos_monitor{name='configListenSize'} | none | listened configuration file count | +| nacos_client_request_seconds_count | none | request count | +| nacos_client_request_seconds_sum | second | request time | + diff --git a/home/docs/help/nebulagraph.md b/home/docs/help/nebulagraph.md index ae2cfb4683f..c23e39c14fe 100644 --- a/home/docs/help/nebulagraph.md +++ b/home/docs/help/nebulagraph.md @@ -14,7 +14,7 @@ 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.** @@ -36,7 +36,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -55,7 +55,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat Too many indicators, related links are as follows **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** -| Metric name | Metric unit | Metric help description | +| 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. | @@ -67,8 +67,9 @@ Too many indicators, related links are as follows Too many indicators, related links are as follows **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |----------------------------|-------------|-------------------------------------------------------------| | rocksdb.backup.read.bytes | | Number of bytes read during the RocksDB database backup. | | rocksdb.backup.write.bytes | | Number of bytes written during the RocksDB database backup. | | ... | | ... | + diff --git a/home/docs/help/nebulagraph_cluster.md b/home/docs/help/nebulagraph_cluster.md index d0da21a7adb..c39195f427e 100644 --- a/home/docs/help/nebulagraph_cluster.md +++ b/home/docs/help/nebulagraph_cluster.md @@ -11,7 +11,7 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open ### Configuration parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------| | Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | | Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | @@ -35,21 +35,21 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open #### Metric Set: Session -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------------|-------------|----------------------------------| | session | None | Number of sessions | | running_query_count | None | Number of queries being executed | #### Metric Set: Jobs -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |--------------|-------------|-------------------------------------------| | queue_jobs | None | Number of pending background tasks | | running_jobs | None | Number of background tasks being executed | #### Metric Set: Cluster node info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------------|-------------|---------------------------------| | total_storage_node | None | Number of storage nodes | | offline_storage_node | None | Number of offline storage nodes | @@ -60,7 +60,7 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open #### Metric Set: Storage Nodes -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-----------------------|-------------|-------------------------------------------------------| | host | None | Node address | | port | None | Port | @@ -89,3 +89,4 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open | version | None | Version | > If you need to customize monitoring templates to collect data from NebulaGraph clusters, please refer to: [NGQL Custom Monitoring](../advanced/extend-ngql.md) + diff --git a/home/docs/help/nginx.md b/home/docs/help/nginx.md index 99bb389000c..f630e4d4d24 100644 --- a/home/docs/help/nginx.md +++ b/home/docs/help/nginx.md @@ -20,6 +20,7 @@ If you want to monitor information in 'Nginx' with this monitoring type, you nee ```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 @@ -50,6 +51,7 @@ server { } } ``` + 4. Reload Nginx ```shell @@ -107,14 +109,13 @@ nginx -s reload 4. Access `http://localhost/req-status` in the browser to view the Nginx monitoring status information. - **Refer Doc: https://github.com/zls0424/ngx_req_status** **⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -128,28 +129,27 @@ nginx -s reload #### 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 | +| 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 | - +| 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/docs/help/ntp.md b/home/docs/help/ntp.md index 5eca6c58e80..666f2a6b39a 100644 --- a/home/docs/help/ntp.md +++ b/home/docs/help/ntp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -23,7 +23,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito #### Metrics Set：summary -| Metric name | Metric unit | Metric help description | +| 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). | diff --git a/home/docs/help/openai.md b/home/docs/help/openai.md index 7fc70548645..7165925372f 100644 --- a/home/docs/help/openai.md +++ b/home/docs/help/openai.md @@ -8,6 +8,7 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI ### Preparation #### Obtain Session Key + > 1. Open Chrome browser's network request interface > `Mac: cmd + option + i` > `Windows: ctrl + shift + i` @@ -22,7 +23,7 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI ### Configuration Parameters -| Parameter Name | Parameter Description | +| Parameter Name | Parameter Description | |:------------------|------------------------------------------------------------------------------------------------| | Monitoring Host | Fill in api.openai.com here. | | Task Name | Identify the name of this monitoring, ensuring uniqueness. | @@ -36,7 +37,7 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI #### Metric Set: Credit Grants -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |----------------------|-------------|--------------------------------------| | Total Granted | USD ($) | Total granted credit limit | | Total Used | USD ($) | Total used credit limit | @@ -45,14 +46,14 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI #### Metric Set: Model Cost -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |-------------|-------------|------------------------| | Model Name | None | Name of the model | | Cost | USD ($) | Expenses for the model | #### Metric Set: Billing Subscription -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |--------------------------|-------------|-----------------------------------------| | Has Payment Method | None | Whether payment method is available | | Canceled | None | Whether subscription is cancelled | @@ -80,3 +81,4 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI | Tax IDs | None | Tax IDs | | Billing Address | None | Billing address | | Business Address | None | Business address | + diff --git a/home/docs/help/opengauss.md b/home/docs/help/opengauss.md index 650882861e8..28171658951 100644 --- a/home/docs/help/opengauss.md +++ b/home/docs/help/opengauss.md @@ -5,54 +5,52 @@ 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. +> 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | diff --git a/home/docs/help/opensuse.md b/home/docs/help/opensuse.md index e4220262e67..acaf86632d4 100644 --- a/home/docs/help/opensuse.md +++ b/home/docs/help/opensuse.md @@ -4,103 +4,105 @@ title: Monitoring OpenSUSE Operating System Monitoring sidebar_label: OpenSUSE OS keywords: [open source monitoring system, open source operating system monitoring, OpenSUSE OS monitoring] --- + > Collect and monitor general performance metrics of the OpenSUSE operating system. ### Configuration Parameters -| Parameter Name | Parameter Help Description | -| -------------- | ---------------------------------------------------------------------------- | -| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). | -| Task Name | The name that identifies this monitoring, which must be unique. | -| Port | The port provided by Linux SSH, default is 22. | -| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. | -| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. | -| Username | SSH connection username, optional. | -| Password | SSH connection password, optional. | -| Collector | Configures which collector is used to schedule data collection for this monitoring. | -| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | -| Binding Tags | Used for categorized management of monitoring resources. | -| Description | Additional notes and descriptions for this monitoring, where users can make notes. | -| Key | The key required to connect to the server. | +| Parameter Name | Parameter Help Description | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). | +| Task Name | The name that identifies this monitoring, which must be unique. | +| Port | The port provided by Linux SSH, default is 22. | +| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. | +| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Configures which collector is used to schedule data collection for this monitoring. | +| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | +| Binding Tags | Used for categorized management of monitoring resources. | +| Description | Additional notes and descriptions for this monitoring, where users can make notes. | +| Key | The key required to connect to the server. | ### Collection Metrics #### Metric Set: System Basic Information -| Metric Name | Unit | Metric Help Description | -| --------------- | ------- | ------------------------ | -| Host Name | None | Host name | -| System Version | None | Operating system version| -| Uptime | None | Uptime | +| Metric Name | Unit | Metric Help Description | +|----------------|------|--------------------------| +| Host Name | None | Host name | +| System Version | None | Operating system version | +| Uptime | None | Uptime | #### Metric Set: CPU Information -| Metric Name | Unit | Metric Help Description | -| --------------- | ----- | ---------------------------------- | -| info | None | CPU model | -| cores | Cores | Number of CPU cores | -| interrupt | Count | Number of CPU interrupts | -| load | None | Average CPU load over the last 1/5/15 minutes | -| context_switch | Count | Number of context switches | -| usage | % | CPU usage rate | +| Metric Name | Unit | Metric Help Description | +|----------------|-------|-----------------------------------------------| +| info | None | CPU model | +| cores | Cores | Number of CPU cores | +| interrupt | Count | Number of CPU interrupts | +| load | None | Average CPU load over the last 1/5/15 minutes | +| context_switch | Count | Number of context switches | +| usage | % | CPU usage rate | #### Metric Set: Memory Information -| Metric Name | Unit | Metric Help Description | -| ----------- | ---- | ------------------------ | -| total | Mb | Total memory capacity | -| used | Mb | Memory used by user programs | -| free | Mb | Free memory capacity | -| buff_cache | Mb | Memory used for cache | +| Metric Name | Unit | Metric Help Description | +|-------------|------|-------------------------------------| +| total | Mb | Total memory capacity | +| used | Mb | Memory used by user programs | +| free | Mb | Free memory capacity | +| buff_cache | Mb | Memory used for cache | | available | Mb | Remaining available memory capacity | -| usage | % | Memory usage rate | +| usage | % | Memory usage rate | #### Metric Set: Disk Information -| Metric Name | Unit | Metric Help Description | -| --------------- | ----- | ----------------------------- | -| disk_num | Count | Total number of disks | -| partition_num | Count | Total number of partitions | -| block_write | Count | Total number of blocks written to disk | -| block_read | Count | Total number of blocks read from disk | -| write_rate | iops | Disk block write rate per second | +| Metric Name | Unit | Metric Help Description | +|---------------|-------|----------------------------------------| +| disk_num | Count | Total number of disks | +| partition_num | Count | Total number of partitions | +| block_write | Count | Total number of blocks written to disk | +| block_read | Count | Total number of blocks read from disk | +| write_rate | iops | Disk block write rate per second | #### Metric Set: Network Card Information -| Metric Name | Unit | Metric Help Description | -| ------------------- | ---- | -------------------------- | -| interface_name | None | Network card name | -| receive_bytes | Mb | Inbound data traffic | -| transmit_bytes | Mb | Outbound data traffic | +| Metric Name | Unit | Metric Help Description | +|----------------|------|-------------------------| +| interface_name | None | Network card name | +| receive_bytes | Mb | Inbound data traffic | +| transmit_bytes | Mb | Outbound data traffic | #### Metric Set: File System | Metric Name | Unit | Metric Help Description | -| ---------- | ---- | ------------------------ | -| filesystem | None | Name of the file system | -| used | Mb | Used disk size | -| available | Mb | Available disk size | -| usage | % | Usage rate | -| mounted | None | Mount point directory | +|-------------|------|-------------------------| +| filesystem | None | Name of the file system | +| used | Mb | Used disk size | +| available | Mb | Available disk size | +| usage | % | Usage rate | +| mounted | None | Mount point directory | #### Metric Set: Top 10 CPU Processes Statistics for the top 10 processes using the CPU. Statistics include: Process ID, CPU usage, memory usage, executed command. -| Metric Name | Unit | Metric Help Description | -| ------------ | ---- | ------------------------ | -| pid | None | Process ID | -| cpu_usage | % | CPU usage rate | -| mem_usage | % | Memory usage rate | -| command | None | Executed command | +| Metric Name | Unit | Metric Help Description | +|-------------|------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage rate | +| mem_usage | % | Memory usage rate | +| command | None | Executed command | #### Metric Set: Top 10 Memory Processes Statistics for the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command. -| Metric Name | Unit | Metric Help Description | -| ------------ | ---- | ------------------------ | -| pid | None | Process ID | -| mem_usage | % | Memory usage rate | -| cpu_usage | % | CPU usage rate | -| command | None | Executed command | \ No newline at end of file +| Metric Name | Unit | Metric Help Description | +|-------------|------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage rate | +| cpu_usage | % | CPU usage rate | +| command | None | Executed command | + diff --git a/home/docs/help/oracle.md b/home/docs/help/oracle.md index 5410e53decb..50d2f6422bc 100644 --- a/home/docs/help/oracle.md +++ b/home/docs/help/oracle.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -27,37 +27,38 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo #### 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 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 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 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 | +| 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/docs/help/ping.md b/home/docs/help/ping.md index c5603fdfbce..7c894f488ff 100644 --- a/home/docs/help/ping.md +++ b/home/docs/help/ping.md @@ -5,32 +5,33 @@ 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. +> 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 | +| 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 | - +| 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 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + diff --git a/home/docs/help/plugin.md b/home/docs/help/plugin.md index b8104a3594a..6c0f938c7a4 100644 --- a/home/docs/help/plugin.md +++ b/home/docs/help/plugin.md @@ -1,10 +1,11 @@ --- id: plugin title: Custom plugin -sidebar_label: Custom plugin +sidebar_label: Custom plugin --- ## Custom plugins + ### Introduction Currently, `Hertzbeat` relies on the `alert` module to notify the user, and then the user can take actions such as sending requests, executing `sql`, executing `shell` scripts, etc. However, this can only be automated manually or by `webhook` to receive the alert message. @@ -13,6 +14,7 @@ After adding the customized code, you only need to package the `plugin` module, Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if you need to set up the trigger method at the time of acquisition, startup program, etc., please mention `Task` in `https://github.com/apache/hertzbeat/issues/new/choose`. ### Specific uses + 1. Pull the master branch code `git clone https://github.com/apache/hertzbeat.git` and locate the `plugin` module's `Plugin` interface. ![plugin-1.png](/img/docs/help/plugin-1.png) @@ -23,3 +25,4 @@ Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if yo 4. Copy the packaged `jar` package to the `ext-lib` directory under the installation directory (for `docker` installations, mount the `ext-lib` directory first, then copy it there). ![plugin-4.png](/img/docs/help/plugin-4.png) 5. Then restart `HertzBeat` to enable the customized post-alert handling policy. + diff --git a/home/docs/help/pop3.md b/home/docs/help/pop3.md index 822192ad66d..fffff2a494f 100644 --- a/home/docs/help/pop3.md +++ b/home/docs/help/pop3.md @@ -24,10 +24,9 @@ If you want to monitor information in 'POP3' with this monitoring type, you just 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 ``` - ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -42,9 +41,8 @@ If you want to monitor information in 'POP3' with this monitoring type, you just #### 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 | - +| 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/docs/help/port.md b/home/docs/help/port.md index e3350a8776f..7f420fd1375 100644 --- a/home/docs/help/port.md +++ b/home/docs/help/port.md @@ -7,25 +7,23 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito > 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 | +### 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 | - - +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | diff --git a/home/docs/help/postgresql.md b/home/docs/help/postgresql.md index de14f9d62eb..57834a713bd 100644 --- a/home/docs/help/postgresql.md +++ b/home/docs/help/postgresql.md @@ -9,50 +9,48 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | diff --git a/home/docs/help/process.md b/home/docs/help/process.md index 599c4f1ea7b..825a20ac43b 100644 --- a/home/docs/help/process.md +++ b/home/docs/help/process.md @@ -4,34 +4,33 @@ title: Monitoring Linux Process Monitoring sidebar_label: Process keywords: [Open Source Monitoring System, Operating System Process Monitoring, Process Monitoring] --- + > Collect and monitor basic information of processes on Linux systems, including CPU usage, memory usage, physical memory, IO, etc. ## Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️: Do not include the protocol header (e.g., https://, http://). | -| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | -| Port | SSH port of the Linux system, default: 22 | -| Timeout | Sets the timeout for the connection in milliseconds, default is 6000 milliseconds. | -| Reuse Connection | Sets whether SSH connection is reused, default is false. When false, a new connection is created for each information retrieval. | -| Username | Username for the server. | -| Password | Password for the server. | -| Process Name | Name or part of the name of the process to be monitored. | -| Collector | Specifies which collector to use for scheduling this monitoring. | -| Monitoring Interval | Interval for periodic data collection, in seconds. Minimum interval that can be set is 30 seconds. | -| Tags | Used for categorizing and managing monitoring resources. | -| Description | Additional notes and descriptions for identifying this monitoring. Users can add remarks here. | -| Private Key | Private key required for connecting to the server. | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Port | SSH port of the Linux system, default: 22 | +| Timeout | Sets the timeout for the connection in milliseconds, default is 6000 milliseconds. | +| Reuse Connection | Sets whether SSH connection is reused, default is false. When false, a new connection is created for each information retrieval. | +| Username | Username for the server. | +| Password | Password for the server. | +| Process Name | Name or part of the name of the process to be monitored. | +| Collector | Specifies which collector to use for scheduling this monitoring. | +| Monitoring Interval | Interval for periodic data collection, in seconds. Minimum interval that can be set is 30 seconds. | +| Tags | Used for categorizing and managing monitoring resources. | +| Description | Additional notes and descriptions for identifying this monitoring. Users can add remarks here. | +| Private Key | Private key required for connecting to the server. | ### Metrics Collected #### Metric Set: Process Basic Information - | Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | ------------------ | +|-------------|-------------|--------------------| | PID | NONE | Process ID | | User | NONE | User | | CPU | NONE | CPU Usage | @@ -41,9 +40,8 @@ keywords: [Open Source Monitoring System, Operating System Process Monitoring, P #### Metric Set: Memory Usage Information - | Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | ------------------ | +|-------------|-------------|--------------------| | PID | NONE | Process ID | | detail | NONE | Detailed metrics | @@ -63,9 +61,8 @@ Includes metrics for: #### Metric Set: Other Monitoring Information - -| Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | --------------------------------- | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|-----------------------------------| | PID | NONE | Process ID | | path | NONE | Execution Path | | date | NONE | Start Time | @@ -73,9 +70,8 @@ Includes metrics for: #### Metric Set: IO - | Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | ------------------ | +|-------------|-------------|--------------------| | PID | NONE | Process ID | | metric | NONE | Metric Name | | value | NONE | Metric Value | @@ -89,3 +85,4 @@ Includes metrics for: - read_bytes (Actual number of bytes read by the process from disk) - write_bytes (Actual number of bytes written by the process to disk) - cancelled_write_bytes (Actual number of bytes cancelled by the process while writing to disk) + diff --git a/home/docs/help/prometheus.md b/home/docs/help/prometheus.md index 4de9f80f67d..571a2e9b51b 100755 --- a/home/docs/help/prometheus.md +++ b/home/docs/help/prometheus.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, Prometheus protocol monitoring ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | | Task Name | Identify the name of this monitoring. The name needs to be unique. | @@ -40,5 +40,3 @@ You can use the following configuration: Keep the rest of the settings default. - - diff --git a/home/docs/help/pulsar.md b/home/docs/help/pulsar.md index 2cc520d6189..1424bd3f58b 100644 --- a/home/docs/help/pulsar.md +++ b/home/docs/help/pulsar.md @@ -4,52 +4,48 @@ title: Monitoring Pulsar Monitoring sidebar_label: Apache Pulsar keywords: [open-source monitoring system, open-source database monitoring, HbaseMaster monitoring] --- + > Collecting and monitoring general performance metrics of Pulsar **Protocol Used: HTTP** ## Configuration Parameters - -| Parameter Name | Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------| | Target Host | The monitored endpoint's IPV4, IPV6, or domain name. Note⚠️: Do not include the protocol header (e.g., https://, http://). | -| Port | The webServicePort value of Pulsar, default is 8080. | -| Task Name | The name identifying this monitoring task, must be unique. | -| Query Timeout | Set the connection timeout in milliseconds, default is 3000 milliseconds. | -| Monitoring Interval | Interval time for periodic data collection, in seconds, minimum interval is 30 seconds. | -| Binding Tags | Used for categorizing monitoring resources. | -| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add more information here. | +| Port | The webServicePort value of Pulsar, default is 8080. | +| Task Name | The name identifying this monitoring task, must be unique. | +| Query Timeout | Set the connection timeout in milliseconds, default is 3000 milliseconds. | +| Monitoring Interval | Interval time for periodic data collection, in seconds, minimum interval is 30 seconds. | +| Binding Tags | Used for categorizing monitoring resources. | +| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add more information here. | ### Collected Metrics #### Metric Set: Version Information - -| Metric Name | Unit | Description | -| ------------ | ---- | ------------------- | -| Version Info | NONE | Version Information | +| Metric Name | Unit | Description | +|--------------|------|---------------------| +| Version Info | NONE | Version Information | #### Metric Set: process_start_time_seconds - -| Metric Name | Unit | Description | -| ------------------ | ---- | ------------------ | -| Process Start Time | NONE | Process Start Time | +| Metric Name | Unit | Description | +|--------------------|------|--------------------| +| Process Start Time | NONE | Process Start Time | #### Metric Set: process_open_fds - -| Metric Name | Unit | Description | -| --------------------- | ---- | ------------------------------- | -| Open File Descriptors | NONE | Number of Open File Descriptors | +| Metric Name | Unit | Description | +|-----------------------|------|---------------------------------| +| Open File Descriptors | NONE | Number of Open File Descriptors | #### Metric Set: process_max_fds - -| Metric Name | Unit | Description | -| -------------------- | ---- | ---------------------------------- | -| Max File Descriptors | NONE | Maximum Number of File Descriptors | +| Metric Name | Unit | Description | +|----------------------|------|------------------------------------| +| Max File Descriptors | NONE | Maximum Number of File Descriptors | #### Metric Set: jvm_memory_pool_allocated_bytes diff --git a/home/docs/help/rabbitmq.md b/home/docs/help/rabbitmq.md index 1bcd3ea5851..917ca63c3d3 100644 --- a/home/docs/help/rabbitmq.md +++ b/home/docs/help/rabbitmq.md @@ -7,7 +7,7 @@ keywords: [open source monitoring tool, open source rabbitmq monitoring tool, mo > Monitoring the running status of RabbitMQ message middleware, nodes, topics and other related metrics. -### Pre-monitoring Operations +### 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 @@ -24,7 +24,7 @@ rabbitmq-plugins enable rabbitmq_management ### Configuration parameters -| Parameter name | Parameter help description | +| 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. | @@ -40,7 +40,7 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: overview -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |--------------------|-------------|------------------------------------| | product_version | None | Product Version | | product_name | None | Product name | @@ -52,7 +52,7 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: object_totals -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |-------------|-------------|-----------------------------| | channels | none | total number of channels | | connections | none | total number of connections | @@ -62,24 +62,24 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: nodes -| Metric Name | Metric Unit | Metric Description | +| 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 | +| 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 | +| 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 | +| 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 | @@ -100,27 +100,27 @@ rabbitmq-plugins enable rabbitmq_management | queue_deleted | None | queue deleted num | | connection_closed | None | connection closed num | - #### metrics: queues -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------| -| name | None | The name of the queue with non-ASCII characters escaped as in C. | +| 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. | +| 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 | +| 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. | +| 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_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_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 | 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_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | + diff --git a/home/docs/help/redhat.md b/home/docs/help/redhat.md index d877c46df36..2a8472e00d6 100644 --- a/home/docs/help/redhat.md +++ b/home/docs/help/redhat.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitoring, ensuring uniqueness. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|---------------------------| | Host Name | None | Host name. | | System Version | None | Operating system version. | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|-------------------------------------------| | info | None | CPU model. | | cores | None | Number of CPU cores. | @@ -47,7 +47,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Memory Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|------------------------------------| | total | Mb | Total memory capacity. | | used | Mb | Used memory by user programs. | @@ -58,7 +58,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Disk Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------|-------------|------------------------------------| | disk_num | None | Total number of disks. | | partition_num | None | Total number of partitions. | @@ -68,7 +68,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Interface Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------------| | interface_name | None | Name of the network interface. | | receive_bytes | Mb | Inbound data traffic. | @@ -105,3 +105,4 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/docs/help/redis.md b/home/docs/help/redis.md index de0df0d52ca..bdb78ce3584 100644 --- a/home/docs/help/redis.md +++ b/home/docs/help/redis.md @@ -2,244 +2,239 @@ id: redis title: 监控：REDIS数据库监控 sidebar_label: REDIS -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] --- > 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|-----------------------------------------------| +| 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 | 无 | 客户端超时表中的客户端数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|--------------------------------------------------------------------------------| +| 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 | 无 | 已延迟释放的对象数。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|----------|-----------------------------------------------------------------------------------------------| +| 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操作期间写入时复制内存的字节大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|--------|-----------------------------------------------------------------------------------------------------| +| 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 | 无 | 正在写入的线程数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|----------------------------------------------------| +| 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的大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-------------------------------------------------------------------------------------| +| 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 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|------------------------| +| 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 | 无 | | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-----------| +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | #### 指标集合：cluster -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------------------| +| 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命令的统计信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------------------------------------------------------------------------------------------------------------------------| +| 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/docs/help/rocketmq.md b/home/docs/help/rocketmq.md index f56bdfc2f14..f31dea47d9b 100644 --- a/home/docs/help/rocketmq.md +++ b/home/docs/help/rocketmq.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] ### Configuration parameters -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Namesrv Host | IPV4,IPV6 of RocketMQ name server(eg: https://, http://)。 | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -24,7 +24,7 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] #### Metric set：cluster -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|---------------------------------------| | BrokerId | none | Broker id | | Address | none | Broker address | @@ -38,7 +38,7 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] #### Metric set：Consumer -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-----------------|-------------|-------------------------| | Consumer_group | none | Consumer group | | Client_quantity | none | Number of clients | @@ -46,3 +46,4 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] | Consume_type | none | Consume type | | Consume_tps | none | Consume tps | | Delay | none | Delay | + diff --git a/home/docs/help/rockylinux.md b/home/docs/help/rockylinux.md index f83eb606b0a..b1e093bc210 100644 --- a/home/docs/help/rockylinux.md +++ b/home/docs/help/rockylinux.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitoring, ensuring uniqueness. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|---------------------------| | Host Name | None | Host name. | | System Version | None | Operating system version. | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|-------------------------------------------| | info | None | CPU model. | | cores | None | Number of CPU cores. | @@ -47,7 +47,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Memory Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|------------------------------------| | total | Mb | Total memory capacity. | | used | Mb | Used memory by user programs. | @@ -58,7 +58,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Disk Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------|-------------|------------------------------------| | disk_num | None | Total number of disks. | | partition_num | None | Total number of partitions. | @@ -68,7 +68,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Interface Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------------| | interface_name | None | Name of the network interface. | | receive_bytes | Mb | Inbound data traffic. | @@ -105,3 +105,4 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/docs/help/shenyu.md b/home/docs/help/shenyu.md index 01523769c78..c7f12bbfaf0 100644 --- a/home/docs/help/shenyu.md +++ b/home/docs/help/shenyu.md @@ -5,27 +5,27 @@ 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. +> monitor ShenYu running status(JVM-related), include request response and other related metrics. -## Pre-monitoring operations +## Pre-monitoring operations -Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 +Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 -Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) +Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) -Two Steps Mainly: +Two Steps Mainly: -1. add metrics plugin dependency in gateway's pom.xml. +1. add metrics plugin dependency in gateway's pom.xml. ```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` -2. modify this config in shenyu gateway yaml. +2. modify this config in shenyu gateway yaml. ```yaml shenyu: @@ -57,75 +57,74 @@ Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond #### Index collection: shenyu_request_total -| Metric Name | Metric Unit | Metric Help Description | -| ----------- |------|-------------------| -| value | None | Collect all requests from ShenYu gateway | +| 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 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 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 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 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 | +|-------------|-------------|-------------------------| +| 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 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 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 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 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 | - +| 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/docs/help/smtp.md b/home/docs/help/smtp.md index 971de82c3e0..fedb17e0040 100644 --- a/home/docs/help/smtp.md +++ b/home/docs/help/smtp.md @@ -13,12 +13,11 @@ Determine whether the server is available through the hello command in SMTP > see https://datatracker.ietf.org/doc/html/rfc821#page-13 - **Protocol Use：SMTP** ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -33,7 +32,7 @@ Determine whether the server is available through the hello command in SMTP #### Metrics Set：summary -| Metric name | Metric unit | Metric help description | +| 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. | diff --git a/home/docs/help/spark.md b/home/docs/help/spark.md index 3d4b44828ea..41865300024 100644 --- a/home/docs/help/spark.md +++ b/home/docs/help/spark.md @@ -15,12 +15,9 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, Refer: https://spark.apache.org/docs/latest/spark-standalone.html - **监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** - - ## 第一步 **修改$SPARK_HOME/conf/spark-env.sh，添加以下语句：** @@ -36,8 +33,6 @@ export SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.manageme 语句中有$JMX_PORT，这个的值可以自定义，也可以获取一个随机数作为端口号。 如果端口自定义为一个具体的值，而 spark 的 Master 和其中之一的 Worker 在同一台机器上，会出现端口冲突的情况。 - - ## 第二步 **vim $SPARK_HOME/conf/metrics.properties 添加如下内容** @@ -50,10 +45,6 @@ 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设置监控端口，在有程序运行的情况下，此端口会被打开。** @@ -69,11 +60,9 @@ gement.jmxremote.port=8711 在spark的Master和Worker正常运行以及spark-submit提交了一个程序的情况下，可以从linux中查询出端口号码。 - - ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -107,16 +96,15 @@ gement.jmxremote.port=8711 #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -125,4 +113,3 @@ gement.jmxremote.port=8711 | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/spring_gateway.md b/home/docs/help/spring_gateway.md index ae24228c222..66c5f0b4f29 100644 --- a/home/docs/help/spring_gateway.md +++ b/home/docs/help/spring_gateway.md @@ -19,6 +19,7 @@ If you want to monitor information in 'Spring Gateway' with this monitoring type spring-boot-starter-actuator ``` + **2. Modify the YML configuration exposure metric interface:** ```yaml @@ -35,56 +36,55 @@ management: ### 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 | +| 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 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 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 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 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 | - +| 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/docs/help/springboot2.md b/home/docs/help/springboot2.md index ca46530f77b..6452aff270e 100644 --- a/home/docs/help/springboot2.md +++ b/home/docs/help/springboot2.md @@ -19,6 +19,7 @@ If you want to monitor information in 'SpringBoot' with this monitoring type, yo spring-boot-starter-actuator ``` + **2. Modify the YML configuration exposure metric interface:** ```yaml @@ -29,7 +30,9 @@ management: 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 @@ -45,47 +48,49 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ } } ``` + ### 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 | +| 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 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 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 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 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/docs/help/springboot3.md b/home/docs/help/springboot3.md index 0dbc32fc834..47b3db10b5c 100644 --- a/home/docs/help/springboot3.md +++ b/home/docs/help/springboot3.md @@ -51,7 +51,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### Configuration Parameters -| Parameter Name | Parameter Description | +| Parameter Name | Parameter Description | |-------------------|----------------------------------------------------------------------------------------------------------------------| | Monitor Host | The monitored peer's IPV4, IPV6, or domain name. Note⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitor, ensuring uniqueness is necessary. | @@ -65,23 +65,28 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### Collection Metrics #### Metric Set: Availability + | Metric Name | Unit | Metric Description | |--------------|------|--------------------| | responseTime | ms | Response time | #### Metric Set: Threads -| Metric Name | Unit | Metric Description | + +| Metric Name | Unit | Metric Description | |-------------|------|----------------------------------| | state | None | Thread state | | size | None | Number of threads for this state | #### Metric Set: Memory Usage -| Metric Name | Unit | Metric Description | + +| Metric Name | Unit | Metric Description | |-------------|------|-----------------------------| | space | None | Memory space name | | mem_used | MB | Memory usage for this space | #### Metric Set: Health Status -| Metric Name | Unit | Metric Description | + +| Metric Name | Unit | Metric Description | |-------------|------|---------------------------------| | status | None | Service health status: UP, Down | + diff --git a/home/docs/help/sqlserver.md b/home/docs/help/sqlserver.md index cc12abf0d7e..71bd8ebdc83 100644 --- a/home/docs/help/sqlserver.md +++ b/home/docs/help/sqlserver.md @@ -9,51 +9,49 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-----------------|-------------|------------------------------| +| user_connection | none | Number of connected sessions | ### Common Problem @@ -61,10 +59,12 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo jdk version: jdk11 Description of the problem: SQL Server 2019 uses the SA user connection to report an error -Error message: +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) diff --git a/home/docs/help/ssl_cert.md b/home/docs/help/ssl_cert.md index 4d808f47dca..77b795fe75a 100644 --- a/home/docs/help/ssl_cert.md +++ b/home/docs/help/ssl_cert.md @@ -9,25 +9,26 @@ keywords: [open source monitoring tool, open source ssl cert monitoring tool, mo ### 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.cn/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 | +| 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.cn/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 | +| 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/docs/help/tidb.md b/home/docs/help/tidb.md index 2a7bc5b65b6..83128c527c8 100644 --- a/home/docs/help/tidb.md +++ b/home/docs/help/tidb.md @@ -1,55 +1,55 @@ ---- -id: tidb -title: Monitoring：TiDB database monitoring -sidebar_label: TiDB database -keywords: [open source monitoring tool, open source database monitoring tool, monitoring tidb database metrics] ---- - -> HertzBeat monitors general performance metrics of TiDB through HTTP and JDBC protocol. - -[Metrics Schema](https://docs.pingcap.com/tidb/stable/metrics-schema) - -[METRICS_SUMMARY](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary) - -[METRICS_TABLES](https://docs.pingcap.com/tidb/stable/information-schema-metrics-tables) - -**Protocol Use: HTTP and JDBC** - -### Configuration parameter - -| Parameter name | Parameter help description | -| ----------- | ----------- | -| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Task name | Identify the name of this monitoring. The name needs to be unique | -| Service Port | The port that the TiDB database provides externally for status reporting is 10080 by default | -| PD Port | The PD port for the TiDB database, which defaults to 2379 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms | -| JDBC Port | The TiDB database externally provides the port used for client requests, which defaults to 4000 | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| JDBC URL | Database using [JDBC](https://docs.pingcap.com/tidb/stable/dev-guide-connect-to-tidb#jdbc) connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - - -### Collection Metric - -The monitoring template will retrieve the monitoring metrics from the TiDB System Variables table, and the user can retrieve the [TiDB System Variables Table](https://docs.pingcap.com/tidb/stable/system-variables) by himself to query the required information or other system variables. - -Besides, TiDB also provides default monitoring metrics table, see [Metrics Schema](https://docs.pingcap.com/tidb/stable/metrics-schema) and [METRICS_SUMMARY](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary), and users can add their own sql codes according to their needs. - -Due to the large number of metrics that can be monitored, only the metrics queried in the monitoring template are described below. - -#### Metric set: global variables - -| Metric Name | Metric Unit | Metric Help Description | -|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| version | none | The MySQL version, followed by the TiDB version. For example '8.0.11-TiDB-v7.5.1'. | -| version_comment | none | The TiDB version. For example, 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible'. | -| version_compile_machine | none | The name of the CPU architecture on which TiDB is running. | -| version_compile_os | none | The name of the OS on which TiDB is running. | -| max_connections | none | The maximum number of concurrent connections permitted for a single TiDB instance. This variable can be used for resources control. The default value 0 means no limit. When the value of this variable is larger than 0, and the number of connections reaches the value, the TiDB server rejects new connections from clients. | -| datadir | none | The location where data is stored. This location can be a local path /tmp/tidb, or point to a PD server if the data is stored on TiKV. A value in the format of ${pd-ip}:${pd-port} indicates the PD server that TiDB connects to on startup. | -| port | none | The port that the tidb-server is listening on when speaking the MySQL protocol. | +--- +id: tidb +title: Monitoring：TiDB database monitoring +sidebar_label: TiDB database +keywords: [open source monitoring tool, open source database monitoring tool, monitoring tidb database metrics] +--- + +> HertzBeat monitors general performance metrics of TiDB through HTTP and JDBC protocol. + +[Metrics Schema](https://docs.pingcap.com/tidb/stable/metrics-schema) + +[METRICS_SUMMARY](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary) + +[METRICS_TABLES](https://docs.pingcap.com/tidb/stable/information-schema-metrics-tables) + +**Protocol Use: HTTP and JDBC** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task name | Identify the name of this monitoring. The name needs to be unique | +| Service Port | The port that the TiDB database provides externally for status reporting is 10080 by default | +| PD Port | The PD port for the TiDB database, which defaults to 2379 | +| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms | +| JDBC Port | The TiDB database externally provides the port used for client requests, which defaults to 4000 | +| Database name | Database instance name, optional | +| Username | Database connection user name, optional | +| Password | Database connection password, optional | +| JDBC URL | Database using [JDBC](https://docs.pingcap.com/tidb/stable/dev-guide-connect-to-tidb#jdbc) connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metric + +The monitoring template will retrieve the monitoring metrics from the TiDB System Variables table, and the user can retrieve the [TiDB System Variables Table](https://docs.pingcap.com/tidb/stable/system-variables) by himself to query the required information or other system variables. + +Besides, TiDB also provides default monitoring metrics table, see [Metrics Schema](https://docs.pingcap.com/tidb/stable/metrics-schema) and [METRICS_SUMMARY](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary), and users can add their own sql codes according to their needs. + +Due to the large number of metrics that can be monitored, only the metrics queried in the monitoring template are described below. + +#### Metric set: global variables + +| Metric Name | Metric Unit | Metric Help Description | +|-------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| version | none | The MySQL version, followed by the TiDB version. For example '8.0.11-TiDB-v7.5.1'. | +| version_comment | none | The TiDB version. For example, 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible'. | +| version_compile_machine | none | The name of the CPU architecture on which TiDB is running. | +| version_compile_os | none | The name of the OS on which TiDB is running. | +| max_connections | none | The maximum number of concurrent connections permitted for a single TiDB instance. This variable can be used for resources control. The default value 0 means no limit. When the value of this variable is larger than 0, and the number of connections reaches the value, the TiDB server rejects new connections from clients. | +| datadir | none | The location where data is stored. This location can be a local path /tmp/tidb, or point to a PD server if the data is stored on TiKV. A value in the format of ${pd-ip}:${pd-port} indicates the PD server that TiDB connects to on startup. | +| port | none | The port that the tidb-server is listening on when speaking the MySQL protocol. | + diff --git a/home/docs/help/time_expression.md b/home/docs/help/time_expression.md index e2cb0928b05..482fc04cc05 100644 --- a/home/docs/help/time_expression.md +++ b/home/docs/help/time_expression.md @@ -23,28 +23,28 @@ ${FORMATTER [{ + | - } ]} > Example outputs are based on the current time being `2022-04-24 02:40:00.123` -| Name | Description | Example | -|---------------|------------------------------------|------------------------| -| @now | Formats as `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | -| @date | Formats as `yyyy-MM-dd` | 2022-04-24 | -| @timestamp10 | Returns 10-digit timestamp | 1650768000 | -| @timestamp | Returns 13-digit timestamp | 1650768000000 | -| @time | Formats as `HH:mm:ss` | 02:40:00 | -| @year | Formats as `yyyy` | 2022 | -| @month | Formats as `MM` | 04 | -| @day | Formats as `dd` | 24 | -| @hour | Formats as `HH` | 02 | -| @minute | Formats as `mm` | 40 | -| @millisecond | Formats as `SSS` | 123 | -| @second | Formats as `ss` | 00 | +| Name | Description | Example | +|--------------|----------------------------------|---------------------| +| @now | Formats as `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | +| @date | Formats as `yyyy-MM-dd` | 2022-04-24 | +| @timestamp10 | Returns 10-digit timestamp | 1650768000 | +| @timestamp | Returns 13-digit timestamp | 1650768000000 | +| @time | Formats as `HH:mm:ss` | 02:40:00 | +| @year | Formats as `yyyy` | 2022 | +| @month | Formats as `MM` | 04 | +| @day | Formats as `dd` | 24 | +| @hour | Formats as `HH` | 02 | +| @minute | Formats as `mm` | 40 | +| @millisecond | Formats as `SSS` | 123 | +| @second | Formats as `ss` | 00 | ### Supported Time Units | Name | Description | |------|-------------| -| y | Year | +| y | Year | | M | Month | -| d | Day | +| d | Day | | H | Hour | | m | Minute | | s | Second | @@ -57,8 +57,9 @@ ${FORMATTER [{ + | - } ]} #### Usage Examples 1. Simple expression - - `${now}` gets the current time and formats it as `yyyy-MM-dd HH:mm:ss` - - `${time+1h}` calculates the time one hour from now and formats it as `HH:mm:ss` - - `${time+1h+15s+30s}` calculates the time one hour, 15 minutes, and 30 seconds from now and formats it as `HH:mm:ss` + - `${now}` gets the current time and formats it as `yyyy-MM-dd HH:mm:ss` + - `${time+1h}` calculates the time one hour from now and formats it as `HH:mm:ss` + - `${time+1h+15s+30s}` calculates the time one hour, 15 minutes, and 30 seconds from now and formats it as `HH:mm:ss` 2. Complex expression template (if the built-in formatter does not meet your needs, you can combine multiple expressions) - - `${@year}年${@month}月${@day}日` returns the current date formatted as yyyy年MM月dd日 + - `${@year}年${@month}月${@day}日` returns the current date formatted as yyyy年MM月dd日 + diff --git a/home/docs/help/tomcat.md b/home/docs/help/tomcat.md index 8b35808ffc8..60591f85579 100644 --- a/home/docs/help/tomcat.md +++ b/home/docs/help/tomcat.md @@ -11,61 +11,60 @@ keywords: [open source monitoring tool, open source tomcat monitoring tool, moni ### 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 | +| 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 | +| 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 | +| 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 | - +| 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 | +| 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 +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 diff --git a/home/docs/help/ubuntu.md b/home/docs/help/ubuntu.md index e7d368c9ea3..8d3b65ce195 100644 --- a/home/docs/help/ubuntu.md +++ b/home/docs/help/ubuntu.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source linux ubuntu monitoring tool ### 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 | +| 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 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 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 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 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 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 | +| 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/docs/help/udp_port.md b/home/docs/help/udp_port.md index 7fdcce3cf77..51c3098dc9a 100644 --- a/home/docs/help/udp_port.md +++ b/home/docs/help/udp_port.md @@ -10,7 +10,7 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| 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. | @@ -26,9 +26,7 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito #### Metric set：summary -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |---------------|-------------------|-------------------------| | Response Time | Milliseconds (ms) | Website response time | - - diff --git a/home/docs/help/website.md b/home/docs/help/website.md index 88d7a1957ad..9458bc6517b 100644 --- a/home/docs/help/website.md +++ b/home/docs/help/website.md @@ -5,25 +5,26 @@ 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. +> Monitor whether the website is available, response time and other Metrics. -### Configuration parameter +### 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.cn/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 | +| 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.cn/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 +### Collection Metric -#### Metric set：summary +#### Metric set：summary + +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| responseTime | ms | Website response time | diff --git a/home/docs/help/websocket.md b/home/docs/help/websocket.md index 8e3d29a204a..13d1f6eed31 100644 --- a/home/docs/help/websocket.md +++ b/home/docs/help/websocket.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, Websocket监控 ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------------|--------------------------------------------------------------------------------------------------------------------------| | Host of WebSocket service | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -23,7 +23,7 @@ keywords: [ open source monitoring tool, Websocket监控 ] #### Metric set：Summary -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |---------------|-------------|-------------------------| | responseTime | ms | Response time | | httpVersion | none | HTTP version | @@ -31,3 +31,4 @@ keywords: [ open source monitoring tool, Websocket监控 ] | statusMessage | none | Status messages | | connection | none | Connect type | | upgrade | none | Upgraded protocols | + diff --git a/home/docs/help/windows.md b/home/docs/help/windows.md index 82e36d23470..e4be2bd6d96 100644 --- a/home/docs/help/windows.md +++ b/home/docs/help/windows.md @@ -6,38 +6,39 @@ keywords: [open source monitoring tool, open source windows monitoring tool, mon --- > Collect and monitor the general performance Metrics of Windows operating system through SNMP protocol. -> Note⚠️ You need to start SNMP service for Windows server. +> 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) +[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 | +| 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 | +| 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 | +| 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/docs/help/yarn.md b/home/docs/help/yarn.md index 176a3209fee..d7f304ff910 100644 --- a/home/docs/help/yarn.md +++ b/home/docs/help/yarn.md @@ -15,69 +15,70 @@ Retrieve the HTTP monitoring port of Apache Yarn. Value: `yarn.resourcemanager.w ## Configuration Parameters -| Parameter Name | Parameter Description | -| ---------------- |----------------------------------------------------| -| Target Host | IP address, IPV6, or domain name of the monitored endpoint. Without protocol header. | -| Port | Monitoring port number of Apache Yarn, default is 8088. | -| Query Timeout | Timeout for querying Apache Yarn, in milliseconds, default is 6000 milliseconds. | +| Parameter Name | Parameter Description | +|------------------|-------------------------------------------------------------------------------------------| +| Target Host | IP address, IPV6, or domain name of the monitored endpoint. Without protocol header. | +| Port | Monitoring port number of Apache Yarn, default is 8088. | +| Query Timeout | Timeout for querying Apache Yarn, in milliseconds, default is 6000 milliseconds. | | Metrics Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. | ### Collected Metrics #### Metric Set: ClusterMetrics -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | -----------------------------------------| -| NumActiveNMs | | Number of currently active NodeManagers | -| NumDecommissionedNMs | | Number of currently decommissioned NodeManagers | -| NumDecommissioningNMs | | Number of nodes currently decommissioning | -| NumLostNMs | | Number of lost nodes in the cluster | -| NumUnhealthyNMs | | Number of unhealthy nodes in the cluster | +| Metric Name | Unit | Metric Description | +|-----------------------|------|-------------------------------------------------| +| NumActiveNMs | | Number of currently active NodeManagers | +| NumDecommissionedNMs | | Number of currently decommissioned NodeManagers | +| NumDecommissioningNMs | | Number of nodes currently decommissioning | +| NumLostNMs | | Number of lost nodes in the cluster | +| NumUnhealthyNMs | | Number of unhealthy nodes in the cluster | #### Metric Set: JvmMetrics -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | -------------------------------------------- | -| MemNonHeapCommittedM | MB | Current committed size of non-heap memory in JVM | -| MemNonHeapMaxM | MB | Maximum available non-heap memory in JVM | -| MemNonHeapUsedM | MB | Current used size of non-heap memory in JVM | -| MemHeapCommittedM | MB | Current committed size of heap memory in JVM | -| MemHeapMaxM | MB | Maximum available heap memory in JVM | -| MemHeapUsedM | MB | Current used size of heap memory in JVM | -| GcTimeMillis | | JVM GC time | -| GcCount | | Number of JVM GC occurrences | +| Metric Name | Unit | Metric Description | +|----------------------|------|--------------------------------------------------| +| MemNonHeapCommittedM | MB | Current committed size of non-heap memory in JVM | +| MemNonHeapMaxM | MB | Maximum available non-heap memory in JVM | +| MemNonHeapUsedM | MB | Current used size of non-heap memory in JVM | +| MemHeapCommittedM | MB | Current committed size of heap memory in JVM | +| MemHeapMaxM | MB | Maximum available heap memory in JVM | +| MemHeapUsedM | MB | Current used size of heap memory in JVM | +| GcTimeMillis | | JVM GC time | +| GcCount | | Number of JVM GC occurrences | #### Metric Set: QueueMetrics -| Metric Name | Unit | Metric Description | -| --------------------------- | ---- | -------------------------------------------- | -| queue | | Queue name | -| AllocatedVCores | | Allocated virtual cores (allocated) | -| ReservedVCores | | Reserved cores | -| AvailableVCores | | Available cores (unallocated) | -| PendingVCores | | Blocked scheduling cores | -| AllocatedMB | MB | Allocated (used) memory size | -| AvailableMB | MB | Available memory (unallocated) | -| PendingMB | MB | Blocked scheduling memory | -| ReservedMB | MB | Reserved memory | -| AllocatedContainers | | Number of allocated (used) containers | -| PendingContainers | | Number of blocked scheduling containers | -| ReservedContainers | | Number of reserved containers | -| AggregateContainersAllocated| | Total aggregated containers allocated | -| AggregateContainersReleased| | Total aggregated containers released | -| AppsCompleted | | Number of completed applications | -| AppsKilled | | Number of killed applications | -| AppsFailed | | Number of failed applications | -| AppsPending | | Number of pending applications | -| AppsRunning | | Number of currently running applications | -| AppsSubmitted | | Number of submitted applications | -| running_0 | | Number of jobs running for less than 60 minutes | -| running_60 | | Number of jobs running between 60 and 300 minutes | -| running_300 | | Number of jobs running between 300 and 1440 minutes | -| running_1440 | | Number of jobs running for more than 1440 minutes | +| Metric Name | Unit | Metric Description | +|------------------------------|------|-----------------------------------------------------| +| queue | | Queue name | +| AllocatedVCores | | Allocated virtual cores (allocated) | +| ReservedVCores | | Reserved cores | +| AvailableVCores | | Available cores (unallocated) | +| PendingVCores | | Blocked scheduling cores | +| AllocatedMB | MB | Allocated (used) memory size | +| AvailableMB | MB | Available memory (unallocated) | +| PendingMB | MB | Blocked scheduling memory | +| ReservedMB | MB | Reserved memory | +| AllocatedContainers | | Number of allocated (used) containers | +| PendingContainers | | Number of blocked scheduling containers | +| ReservedContainers | | Number of reserved containers | +| AggregateContainersAllocated | | Total aggregated containers allocated | +| AggregateContainersReleased | | Total aggregated containers released | +| AppsCompleted | | Number of completed applications | +| AppsKilled | | Number of killed applications | +| AppsFailed | | Number of failed applications | +| AppsPending | | Number of pending applications | +| AppsRunning | | Number of currently running applications | +| AppsSubmitted | | Number of submitted applications | +| running_0 | | Number of jobs running for less than 60 minutes | +| running_60 | | Number of jobs running between 60 and 300 minutes | +| running_300 | | Number of jobs running between 300 and 1440 minutes | +| running_1440 | | Number of jobs running for more than 1440 minutes | #### Metric Set: runtime -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | --------------------------| -| StartTime | | Startup timestamp | \ No newline at end of file +| Metric Name | Unit | Metric Description | +|-------------|------|--------------------| +| StartTime | | Startup timestamp | + diff --git a/home/docs/help/zookeeper.md b/home/docs/help/zookeeper.md index b7a34f49eda..f14b0bb8273 100644 --- a/home/docs/help/zookeeper.md +++ b/home/docs/help/zookeeper.md @@ -10,10 +10,12 @@ keywords: [open source monitoring tool, open source zookeeper monitoring tool, m ### 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. + +> 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 @@ -28,73 +30,74 @@ Steps > 3.Restart service -```shell +```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 -``` +> +> ```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 | +| 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 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 | - +| 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/docs/introduce.md b/home/docs/introduce.md index d559fa6ca34..efe90433786 100644 --- a/home/docs/introduce.md +++ b/home/docs/introduce.md @@ -5,7 +5,7 @@ sidebar_label: Introduce slug: / --- -> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +> 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/) @@ -32,11 +32,9 @@ slug: / * 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. -> 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. @@ -49,7 +47,6 @@ Do you believe that users can just write a monitoring template on the UI page, c ![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**. @@ -97,7 +94,7 @@ Do you believe that users can just write a monitoring template on the UI page, c > 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. +> 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) @@ -105,12 +102,12 @@ Do you believe that users can just write a monitoring template on the UI page, c > 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 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`. +The principle of `HertzBeat` is to use different protocols to connect directly to the end system, and use the `PULL` form to pull the collected data, without the need for the user to deploy and install `Agent` | `Exporter` on the host of the end, etc. For example, monitoring the `linux operating system`. - For example, if you want to monitor `linux OS`, you can just input the IP port account password or key on `HertzBeat` side. -- For example, to monitor `linux OS`, just enter your ip/port account password or key in `HertzBeat`. +- For example, 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**. @@ -129,7 +126,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > Two locations, three centers, multi-cloud environments, multi-isolated networks, you may have heard of these scenarios. When there is a need for a unified monitoring system to monitor the IT resources of different isolated networks, this is where our Cloud Edge Collaboration comes in. In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance. -`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` 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) @@ -148,12 +145,11 @@ In an isolated network where multiple networks are not connected, we need to dep - Built on `Java+SpringBoot+TypeScript+Angular` mainstream technology stack , convenient secondary development . - Open source is not the same as free, dev based on HertzBeat must retain page footnotes, copyright, etc. - **HertzBeat has been included in the [CNCF Observability And Analysis - Monitoring Landscape](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category)** ![cncf](/img/home/cncf-landscape-left-logo.svg) ------ +--- **HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.** @@ -271,7 +267,6 @@ Built-in support for monitoring types include: ![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. @@ -303,7 +298,6 @@ Built-in support for monitoring types include: ![hertzbeat](/img/home/9.png) - ----- **There's so much more to discover. Have Fun!** diff --git a/home/docs/others/design.md b/home/docs/others/design.md index e7f80d164d7..da5ec8fffee 100644 --- a/home/docs/others/design.md +++ b/home/docs/others/design.md @@ -1,9 +1,9 @@ --- id: design title: 设计文档 -sidebar_label: 设计文档 +sidebar_label: 设计文档 --- -### HertzBeat Arch +### HertzBeat Arch -![architecture](/img/docs/hertzbeat-arch.svg) +![architecture](/img/docs/hertzbeat-arch.svg) diff --git a/home/docs/others/resource.md b/home/docs/others/resource.md index 79c16b4ab56..83188bd1c8e 100644 --- a/home/docs/others/resource.md +++ b/home/docs/others/resource.md @@ -1,19 +1,19 @@ --- id: resource title: Related resources -sidebar_label: Related resources +sidebar_label: Related resources --- -## Icon Resources +## Icon Resources -### HertzBeat Logo +### HertzBeat Logo -![logo](/img/hertzbeat-logo.svg) +![logo](/img/hertzbeat-logo.svg) -Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) +Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) -### HertzBeat Brand Logo +### HertzBeat Brand Logo -![logo](/img/hertzbeat-brand.svg) +![logo](/img/hertzbeat-brand.svg) -Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) +Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) diff --git a/home/docs/start/account-modify.md b/home/docs/start/account-modify.md index 81a1f573573..52ddf334e43 100644 --- a/home/docs/start/account-modify.md +++ b/home/docs/start/account-modify.md @@ -1,7 +1,7 @@ --- id: account-modify title: Modify Account Username Password And Secret -sidebar_label: Update Account Secret +sidebar_label: Update Account Secret --- ## Update Account @@ -141,12 +141,11 @@ account: role: [user] ``` -## Update Security Secret +## Update Security Secret -> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. +> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. - -Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. +Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. ```yaml sureness: @@ -157,4 +156,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**Restart HertzBeat, access http://ip:1157/ to explore** +**Restart HertzBeat, access http://ip:1157/ to explore** diff --git a/home/docs/start/custom-config.md b/home/docs/start/custom-config.md index 91282bf5055..f58450a2736 100644 --- a/home/docs/start/custom-config.md +++ b/home/docs/start/custom-config.md @@ -1,7 +1,7 @@ --- id: custom-config title: Advanced Params Config -sidebar_label: 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. @@ -12,13 +12,14 @@ This describes how to configure the SMS server, the number of built-in availabil 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` +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) +Add the following Tencent platform SMS server configuration in `application.yml` (parameters need to be replaced with your SMS server configuration) + ```yaml common: sms: @@ -32,7 +33,6 @@ common: 2. Configure alarm custom parameters - ```yaml alerter: # Custom console address @@ -44,6 +44,7 @@ alerter: > 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: @@ -56,3 +57,4 @@ warehouse: port: 6379 password: 123456 ``` + diff --git a/home/docs/start/docker-deploy.md b/home/docs/start/docker-deploy.md index 338773af890..d021b645645 100644 --- a/home/docs/start/docker-deploy.md +++ b/home/docs/start/docker-deploy.md @@ -1,52 +1,51 @@ --- id: docker-deploy title: Install HertzBeat via Docker -sidebar_label: Install via Docker +sidebar_label: Install via Docker --- > Recommend to use docker deploy Apache HertzBeat (incubating) - 1. Download and install the Docker environment Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 After the installation you can check if the Docker version normally output at the terminal. + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` - 2. pull HertzBeat Docker mirror you can look up the mirror version TAG in [dockerhub mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) - or in [quay.io mirror repository](https://quay.io/repository/tancloud/hertzbeat) + or in [quay.io mirror repository](https://quay.io/repository/tancloud/hertzbeat) + ```shell $ docker pull apache/hertzbeat $ docker pull apache/hertzbeat-collector ``` - or + + or + ```shell $ docker pull quay.io/tancloud/hertzbeat $ docker pull quay.io/tancloud/hertzbeat-collector ``` - 3. Mounted HertzBeat configuration file (optional) Mounted and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` ```-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml```` Download from [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - You can modify the configuration yml file according to your needs. - - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` - - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) - - **Recommended** If you need to use the time series database victoria-metrics to store metric data, you need to replace the `warehouse.store.victoria-metrics` parameter in `application.yml` for specific steps, see [Using victoria-metrics to store metrics data](victoria-metrics-init) - + You can modify the configuration yml file according to your needs. + - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` + - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) + - **Recommended** If you need to use the time series database victoria-metrics to store metric data, you need to replace the `warehouse.store.victoria-metrics` parameter in `application.yml` for specific steps, see [Using victoria-metrics to store metrics data](victoria-metrics-init) 4. Mounted the account file(optional) HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` If you need update account or password, configure `sureness.yml`. Ignore this step without this demand. Download and config `sureness.yml` in the host directory，eg:`$(pwd)/sureness.yml` Download from [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) - For detail steps, please refer to [Configure Account Password](account-modify) + For detail steps, please refer to [Configure Account Password](account-modify) +5. Start the HertzBeat Docker container -5. Start the HertzBeat Docker container - -```shell +```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=en_US.UTF-8 \ -e TZ=Asia/Shanghai \ @@ -57,25 +56,25 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ --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.** +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 +6. Begin to explore HertzBeat - Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 7. Deploy collector cluster (Optional) -```shell +```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ @@ -84,45 +83,51 @@ $ docker run -d \ --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.** +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. +8. Access `http://localhost:1157` and you will see the registered new collector in dashboard. -**HAVE FUN** +**HAVE FUN** -### FAQ +### 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. + 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 .....` +> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy，visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issues： + 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. **Historical monitoring charts have been missing data for a long time** +3. **Historical monitoring charts have been missing data for a long time** + > 1：Check whether you configure victoria-metrics or Tdengine or IoTDB. No configuration means no historical chart data. > 2: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. 4. If the history chart on the monitoring page is not displayed，popup [please configure time series database] + > As shown in the popup window，the premise of history chart display is that you need install and configure hertzbeat's dependency service database. > Installation and initialization this database, please refer to [Using victoria-metrics to store metrics data](victoria-metrics-init) 5. 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 time-series database enable set to true > Note⚠️If both hertzbeat and time-series database are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed > You can check the startup logs according to the logs directory + diff --git a/home/docs/start/greptime-init.md b/home/docs/start/greptime-init.md index 1ed73d35cfe..5f4409f9173 100644 --- a/home/docs/start/greptime-init.md +++ b/home/docs/start/greptime-init.md @@ -8,22 +8,25 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie > It is recommended to use VictoriaMetrics as metrics storage. -GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. +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.** +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** + +### Install GreptimeDB via Docker -### 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 +> 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 \ @@ -33,10 +36,11 @@ $ docker run -p 4000-4004:4000-4004 \ --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 +`-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 diff --git a/home/docs/start/influxdb-init.md b/home/docs/start/influxdb-init.md index 1dd7c28785f..c1cb2740b93 100644 --- a/home/docs/start/influxdb-init.md +++ b/home/docs/start/influxdb-init.md @@ -1,51 +1,54 @@ --- id: influxdb-init title: Use Time Series Database InfluxDB to Store Metrics Data (Optional) -sidebar_label: Use InfluxDB Store Metrics +sidebar_label: Use InfluxDB Store Metrics --- Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) > It is recommended to use VictoriaMetrics as metrics storage. - **Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance** **⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** -Note⚠️ Need InfluxDB 1.x Version. +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. +> +> 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 +### 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. 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 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. + Replace `warehouse.store.influxdb` data source parameters, URL account and password. ```yaml warehouse: @@ -70,3 +73,4 @@ warehouse: 1. Do both the time series databases InfluxDB, IoTDB and TDengine need to be configured? Can they both be used? > You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. + diff --git a/home/docs/start/iotdb-init.md b/home/docs/start/iotdb-init.md index ee7a66a87f4..43fb3235406 100644 --- a/home/docs/start/iotdb-init.md +++ b/home/docs/start/iotdb-init.md @@ -3,6 +3,7 @@ id: iotdb-init title: Use Time Series Database IoTDB to Store Metrics Data (Optional) sidebar_label: Use IoTDB Store Metrics --- + Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) > It is recommended to use VictoriaMetrics as metrics storage. @@ -87,9 +88,8 @@ warehouse: Configuration parameters: - -| Parameter Name | Description | -| ------------------- |-------------------------------------------------------------------------------------------| +| Parameter Name | Description | +|---------------------|-------------------------------------------------------------------------------------------| | enabled | Whether to enable | | host | IoTDB database address | | rpc-port | IoTDB database port | @@ -120,3 +120,4 @@ Configuration parameters: > Is td-engine enable set to true > Note⚠️If both hertzbeat and TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed > You can check the startup logs according to the logs directory + diff --git a/home/docs/start/mysql-change.md b/home/docs/start/mysql-change.md index f224a418e4f..1beda158214 100644 --- a/home/docs/start/mysql-change.md +++ b/home/docs/start/mysql-change.md @@ -1,21 +1,25 @@ --- id: mysql-change title: Use MYSQL Replace H2 Database to Store Metadata(Optional) -sidebar_label: Use MYSQL Instead of H2 +sidebar_label: Use MYSQL Instead of H2 --- -MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. -> If you have the MYSQL environment, can be directly to database creation step. +MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. + +> If you have the MYSQL environment, can be directly to database creation step. + +### Install MYSQL via Docker -### Install MYSQL via Docker 1. Download and install the Docker environment For Docker installation, please refer to the [Docker official documentation](https://docs.docker.com/get-docker/). After the installation, please verify in the terminal that the Docker version can be printed normally. + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. Install MYSQl with Docker +2. Install MYSQl with Docker + ``` $ docker run -d --name mysql \ -p 3306:3306 \ @@ -24,12 +28,14 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data --restart=always \ mysql:5.7 ``` + `-v /opt/data:/var/lib/mysql` is local persistent mount of mysql data directory. `/opt/data` should be replaced with the actual local directory. use ```$ docker ps``` to check if the database started successfully -### Database creation +### Database creation + 1. Enter MYSQL or use the client to connect MYSQL service - `mysql -uroot -p123456` + `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 @@ -40,8 +46,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data - Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.0.26.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 - Copy the jar package to the `hertzbeat/ext-lib` directory. - -### Modify hertzbeat's configuration file application.yml and switch data source +### Modify hertzbeat's configuration file application.yml and switch data source - Configure HertzBeat's configuration file Modify `hertzbeat/config/application.yml` configuration file @@ -49,6 +54,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data Replace `spring.database` data source parameters, URL account and password. For example: + ```yaml spring: datasource: @@ -59,7 +65,9 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data jpa: database: h2 ``` - Specific replacement parameters are as follows and you need to configure account according to the mysql environment: + + Specific replacement parameters are as follows and you need to configure account according to the mysql environment: + ```yaml spring: datasource: @@ -71,7 +79,6 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data jpa: database: mysql ``` +- It is recommended to set the host field in the MySQL URL or Redis URL to the public IP address when using Hertzbeat in docker. -- It is recommended to set the host field in the MySQL URL or Redis URL to the public IP address when using Hertzbeat in docker. - -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/docs/start/package-deploy.md b/home/docs/start/package-deploy.md index 050121f5c55..cbd42ad5bb9 100644 --- a/home/docs/start/package-deploy.md +++ b/home/docs/start/package-deploy.md @@ -9,14 +9,15 @@ sidebar_label: Install via Package 1. Download HertzBeat installation package Download installation package `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` corresponding to your system environment - [Download Page](/docs/download) - 2. Configure HertzBeat's configuration file(optional) - Unzip the installation package to the host eg: /opt/hertzbeat - ``` + 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) @@ -27,22 +28,23 @@ sidebar_label: Install via Package 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) + 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. - ``` + Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. + + ``` $ ./startup.sh ``` +5. Begin to explore HertzBeat -5. Begin to explore HertzBeat - - Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 6. Deploy collector clusters (Optional) - - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](/docs/download) + - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](/docs/download) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` + ```yaml collector: dispatch: @@ -59,7 +61,7 @@ sidebar_label: Install via Package **HAVE FUN** -### FAQ +### FAQ 1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance** @@ -67,6 +69,7 @@ sidebar_label: Install via Package requirement：JDK17 ENV download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) After installation use command line to check whether you install it successfully. + ``` $ java -version java version "17.0.9" @@ -74,18 +77,20 @@ sidebar_label: Install via Package Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) ``` - 2. **According to the process deploy，visit http://ip:1157/ no interface** 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. +> 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/docs/start/postgresql-change.md b/home/docs/start/postgresql-change.md index c78a24a1ca7..ac63a41ebc9 100644 --- a/home/docs/start/postgresql-change.md +++ b/home/docs/start/postgresql-change.md @@ -3,27 +3,35 @@ id: postgresql-change title: Use PostgreSQL Replace H2 Database to Store Metadata(Optional) sidebar_label: Use PostgreSQL Instead of H2 --- + PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information. > If you have the PostgreSQL environment, can be directly to database creation step. ### Install PostgreSQL via Docker + 1. Download and install the Docker environment Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 After the installation you can check if the Docker version normally output at the terminal. + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` 2. Install PostgreSQL with Docker + ``` $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` + use```$ docker ps```to check if the database started successfully + 3. Create database in container manually or with [script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-iotdb/conf/sql/schema.sql). ### Database creation -1. Enter postgreSQL or use the client to connect postgreSQL service + +1. Enter postgreSQL or use the client to connect postgreSQL service + ``` su - postgres psql @@ -39,6 +47,7 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition 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: @@ -47,7 +56,9 @@ spring: 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: @@ -70,4 +81,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md index 7be19dcd691..8a2d1743b65 100644 --- a/home/docs/start/quickstart.md +++ b/home/docs/start/quickstart.md @@ -1,7 +1,7 @@ --- id: quickstart title: Quick Start -sidebar_label: Quick Start +sidebar_label: Quick Start --- ### 🐕 Quick Start @@ -29,6 +29,7 @@ sidebar_label: Quick Start ``` 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. @@ -45,6 +46,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache 5. Deploy collector clusters(Optional) - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](https://hertzbeat.apache.org/docs/download) - 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: @@ -68,9 +70,9 @@ Detailed config refer to [Install HertzBeat via Package](package-deploy) 3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. 4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` -Detailed steps refer to [CONTRIBUTING](../community/contribution) +Detailed steps refer to [CONTRIBUTING](../community/contribution) -##### 4：Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose +##### 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). @@ -82,4 +84,4 @@ 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** +**HAVE FUN** diff --git a/home/docs/start/rainbond-deploy.md b/home/docs/start/rainbond-deploy.md index 57f537aa4ac..ef2c581d57d 100644 --- a/home/docs/start/rainbond-deploy.md +++ b/home/docs/start/rainbond-deploy.md @@ -1,7 +1,7 @@ --- id: rainbond-deploy title: Use Rainbond Deploy HertzBeat -sidebar_label: Install via Rainbond +sidebar_label: Install via Rainbond --- If you are unfamiliar with Kubernetes, and want to install Apache HertzBeat (incubating) in Kubernetes, you can use Rainbond to deploy. Rainbond is a cloud-native application management platform built on Kubernetes and simplifies the application deployment to Kubernetes. diff --git a/home/docs/start/sslcert-practice.md b/home/docs/start/sslcert-practice.md index d8c06a8beba..26c7f6ecf32 100644 --- a/home/docs/start/sslcert-practice.md +++ b/home/docs/start/sslcert-practice.md @@ -12,7 +12,6 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v Apache HertzBeat (incubating) is a real-time monitoring tool with powerful custom monitoring capabilities without Agent. Website monitoring, PING connectivity, port availability, database, operating system, middleware, API monitoring, threshold alarms, alarm notification (email, WeChat, Ding Ding Feishu). - github: https://github.com/apache/hertzbeat #### Install HertzBeat @@ -29,7 +28,6 @@ github: https://github.com/apache/hertzbeat > System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate - ![](/img/docs/start/ssl_1.png) 2. Configure the monitoring website @@ -43,48 +41,38 @@ github: https://github.com/apache/hertzbeat > 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 @@ -93,7 +81,6 @@ https://hertzbeat.apache.org/docs/help/alert_dingtalk > 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. diff --git a/home/docs/start/tdengine-init.md b/home/docs/start/tdengine-init.md index d96223c4cb1..414f079a962 100644 --- a/home/docs/start/tdengine-init.md +++ b/home/docs/start/tdengine-init.md @@ -1,85 +1,90 @@ --- id: tdengine-init title: Use Time Series Database TDengine to Store Metrics Data (Optional) -sidebar_label: Use TDengine Store Metrics +sidebar_label: Use TDengine Store Metrics --- Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) > It is recommended to use VictoriaMetrics as metrics storage. -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. +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. +Note⚠️ Need TDengine 3.x Version. -> If you have TDengine environment, can directly skip to create a database instance. +> If you have TDengine environment, can directly skip to create a database instance. +### Install TDengine via Docker -### 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. 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 -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: - + 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 - + + 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 - +3. Check if hertzbeat database has been created success + ``` taos> show databases; taos> use hertzbeat; ``` -**Note⚠️If you install TDengine using package** +**Note⚠️If you install TDengine using package** > In addition to start the server，you must execute `systemctl start taosadapter` to start adapter -### Configure the database connection in hertzbeat `application.yml` configuration file +### Configure the database connection in hertzbeat `application.yml` configuration file 1. Configure HertzBeat's configuration file Modify `hertzbeat/config/application.yml` configuration file Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.td-engine` data source parameters, URL account and password. + Replace `warehouse.store.td-engine` data source parameters, URL account and password. ```yaml warehouse: @@ -101,16 +106,21 @@ warehouse: ### 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. +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 +> You can check the startup logs according to the logs directory + diff --git a/home/docs/start/upgrade.md b/home/docs/start/upgrade.md index 8ad14d3b673..ebd4af61e70 100644 --- a/home/docs/start/upgrade.md +++ b/home/docs/start/upgrade.md @@ -1,7 +1,7 @@ --- id: upgrade title: HertzBeat New Version Upgrade -sidebar_label: Version Upgrade Guide +sidebar_label: Version Upgrade Guide --- **HertzBeat Release Version List** @@ -14,7 +14,6 @@ Apache HertzBeat (incubating)'s metadata information is stored in H2 or Mysql, P **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 @@ -22,30 +21,26 @@ Apache HertzBeat (incubating)'s metadata information is stored in H2 or Mysql, P - `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 +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 +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 +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 +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** +**HAVE FUN** diff --git a/home/docs/start/victoria-metrics-init.md b/home/docs/start/victoria-metrics-init.md index 327bc4999af..3d0c22901a8 100644 --- a/home/docs/start/victoria-metrics-init.md +++ b/home/docs/start/victoria-metrics-init.md @@ -1,7 +1,7 @@ --- id: victoria-metrics-init title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended) -sidebar_label: Use VictoriaMetrics Store Metrics(Recommended) +sidebar_label: Use VictoriaMetrics Store Metrics(Recommended) --- Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) @@ -15,17 +15,19 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t > If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step. -### Install VictoriaMetrics via Docker +### 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 +> 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 \ @@ -34,8 +36,8 @@ $ docker run -d -p 8428:8428 \ 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 +`-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 @@ -61,5 +63,7 @@ warehouse: ### FAQ -1. Do both the time series databases need to be configured? Can they both be used? +1. Do both the time series databases need to be configured? Can they both be used? + > You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which can affects the historical chart data. + diff --git a/home/docs/template.md b/home/docs/template.md index 4bdf785e588..cee7aa05055 100644 --- a/home/docs/template.md +++ b/home/docs/template.md @@ -4,27 +4,27 @@ title: Monitoring Template Here sidebar_label: Monitoring Template --- -> Apache HertzBeat (incubating) is an open source, real-time monitoring tool with custom-monitor and agentLess. - +> Apache HertzBeat (incubating) is an open source, real-time monitoring tool with custom-monitor and agentLess. +> > We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? -Here is the architecture. +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!** +**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 +### 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)
+ 👉 [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)
@@ -32,7 +32,7 @@ Here is the architecture.  👉 [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 +### 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)
@@ -49,7 +49,7 @@ Here is the architecture.  👉 [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 +### 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)
@@ -64,7 +64,6 @@ Here is the architecture.  👉 [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)
@@ -78,13 +77,12 @@ Here is the architecture.  👉 [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 +### 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)
diff --git a/pom.xml b/pom.xml index 60a476dda7a..aaccb1e522f 100644 --- a/pom.xml +++ b/pom.xml @@ -460,7 +460,37 @@ - + + com.diffplug.spotless + spotless-maven-plugin + 2.40.0 + + false + + + home/docs/**/*.md + + + + Markdown Formatter + (^-*\n$)([\s\S]*?)(-+$) + ---$2--- + + + + true + + + + + spotless-check + + check + + validate + + + From 26ee7ccf19d85d4d12a5d90b00b15fe8c3740c42 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 13 Aug 2024 10:28:40 +0800 Subject: [PATCH 2/4] [feature]add markdown formatter --- home/README.md | 4 +- home/blog/2022-06-01-hertzbeat-v1.0.md | 7 +- home/blog/2022-06-19-hertzbeat-v1.1.0.md | 17 +- home/blog/2022-06-22-one-step-up.md | 15 +- home/blog/2022-07-10-hertzbeat-v1.1.1.md | 8 +- home/blog/2022-09-04-hertzbeat-v1.1.3.md | 13 +- home/blog/2022-09-10-ssl-practice.md | 18 +- home/blog/2022-10-08-hertzbeat-v1.2.0.md | 7 +- home/blog/2022-11-28-hertzbeat-v1.2.2.md | 9 +- home/blog/2022-12-19-new-committer.md | 36 +- home/blog/2022-12-28-hertzbeat-v1.2.3.md | 6 +- home/blog/2023-01-05-monitor-iotdb.md | 4 +- home/blog/2023-01-08-monitor-shenyu.md | 13 +- home/blog/2023-02-02-monitor-dynamic-tp.md | 3 - home/blog/2023-02-10-new-committer.md | 45 +- home/blog/2023-02-11-monitor-mysql.md | 9 +- home/blog/2023-02-15-monitor-linux.md | 7 +- home/blog/2023-03-15-hertzbeat-v1.3.0.md | 22 +- home/blog/2023-03-22-monitor-springboot2.md | 21 +- home/blog/2023-05-09-hertzbeat-v1.3.1.md | 15 +- home/blog/2023-05-11-greptimedb-store.md | 5 +- home/blog/2023-07-05-hertzbeat-v1.3.2.md | 23 +- home/blog/2023-08-14-hertzbeat-v1.4.0.md | 12 +- home/blog/2023-08-28-new-committer.md | 4 - home/blog/2023-09-26-hertzbeat-v1.4.1.md | 13 +- home/blog/2023-11-12-hertzbeat-v1.4.2.md | 16 +- home/blog/2023-12-11-hertzbeat-v1.4.3.md | 14 +- home/blog/2024-01-11-new-committer.md | 20 +- home/blog/2024-01-18-hertzbeat-v1.4.4.md | 22 +- home/blog/2024-04-17-to-apache.md | 8 +- ...-09-hertzbeat-ospp-subject-introduction.md | 25 +- .../2024-06-11-hertzbeat-v1.6.0-update.md | 39 +- home/blog/2024-06-15-hertzbeat-v1.6.0.md | 11 +- home/blog/2024-07-07-new-committer.md | 4 - home/blog/2024-07-08-new-committer.md | 2 - home/blog/2024-07-15-new-committer.md | 1 - home/blog/2024-07-27-new-committer.md | 6 +- home/blog/2024-07-28-new-committer.md | 7 +- home/blog/2024-07-29-new-committer.md | 5 + .../2022-06-01-hertzbeat-v1.0.md | 14 +- .../2022-06-19-hertzbeat-v1.1.0.md | 27 +- .../2022-06-22-one-step-up.md | 26 +- .../2022-07-10-hertzbeat-v1.1.1.md | 12 +- .../2022-09-04-hertzbeat-v1.1.3.md | 22 +- .../2022-09-10-ssl-practice.md | 18 +- .../2022-10-08-hertzbeat-v1.2.0.md | 26 +- .../2022-11-28-hertzbeat-v1.2.2.md | 9 +- .../2022-12-19-new-committer.md | 36 +- .../2022-12-28-hertzbeat-v1.2.3.md | 6 +- .../2023-01-05-monitor-iotdb.md | 90 ++- .../2023-01-08-monitor-shenyu.md | 93 ++- .../2023-02-02-monitor-dynamic-tp.md | 95 ++- .../2023-02-10-new-committer.md | 25 +- .../2023-02-11-monitor-mysql.md | 83 +-- .../2023-02-15-monitor-linux.md | 178 +++-- .../2023-03-15-hertzbeat-v1.3.0.md | 34 +- .../2023-03-22-monitor-springboot2.md | 102 ++- .../2023-05-09-hertzbeat-v1.3.1.md | 16 +- .../2023-05-11-greptimedb-store.md | 3 +- .../2023-07-05-hertzbeat-v1.3.2.md | 22 +- .../2023-08-14-hertzbeat-v1.4.0.md | 41 +- .../2023-08-28-new-committer.md | 38 +- .../2023-09-26-hertzbeat-v1.4.1.md | 16 +- .../2023-11-12-hertzbeat-v1.4.2.md | 16 +- .../2023-12-11-hertzbeat-v1.4.3.md | 15 +- .../2024-01-11-new-committer.md | 20 +- .../2024-01-18-hertzbeat-v1.4.4.md | 23 +- .../2024-04-17-to-apache.md | 13 +- ...-09-hertzbeat-ospp-subject-introduction.md | 22 +- .../2024-06-11-hertzbeat-v1.6.0-update.md | 27 +- .../2024-06-15-hertzbeat-v1.6.0.md | 11 +- .../2024-07-07-new-committer.md | 4 - .../2024-07-08-new-committer.md | 5 +- .../2024-07-15-new-committer.md | 2 - .../2024-07-27-new-committer.md | 2 +- .../2024-07-28-new-committer.md | 6 +- .../2024-07-29-new-committer.md | 7 +- .../current/advanced/extend-http-default.md | 24 +- .../advanced/extend-http-example-hertzbeat.md | 18 +- .../advanced/extend-http-example-token.md | 26 +- .../current/advanced/extend-http-jsonpath.md | 30 +- .../current/advanced/extend-http.md | 23 +- .../current/advanced/extend-jdbc.md | 53 +- .../current/advanced/extend-jmx.md | 23 +- .../current/advanced/extend-ngql.md | 8 +- .../current/advanced/extend-point.md | 13 +- .../current/advanced/extend-snmp.md | 23 +- .../current/advanced/extend-ssh.md | 47 +- .../current/advanced/extend-telnet.md | 20 +- .../current/advanced/extend-tutorial.md | 18 +- .../current/community/become_committer.md | 30 +- .../current/community/become_pmc_member.md | 30 +- .../community/code-style-and-quality-guide.md | 638 ++++++++-------- .../current/community/contact.md | 3 +- .../current/community/contribution.md | 45 +- .../current/community/development.md | 6 +- .../current/community/document.md | 29 +- .../current/community/how-to-release.md | 53 +- .../current/community/how-to-verify.md | 20 +- .../current/community/mailing_lists.md | 42 +- .../community/new_committer_process.md | 50 +- .../community/new_pmc_member_process.md | 30 +- .../current/community/submit-code.md | 80 +- .../current/download.md | 9 +- .../current/help/activemq.md | 128 ++-- .../current/help/ai_config.md | 64 +- .../current/help/airflow.md | 40 +- .../current/help/alert_console.md | 4 +- .../current/help/alert_dingtalk.md | 20 +- .../current/help/alert_discord.md | 42 +- .../current/help/alert_email.md | 31 +- .../help/alert_enterprise_wechat_app.md | 16 +- .../current/help/alert_feishu.md | 22 +- .../current/help/alert_slack.md | 27 +- .../current/help/alert_telegram.md | 33 +- .../current/help/alert_threshold.md | 3 +- .../current/help/alert_threshold_expr.md | 33 +- .../current/help/alert_webhook.md | 46 +- .../current/help/alert_wework.md | 28 +- .../current/help/almalinux.md | 141 ++-- .../current/help/api.md | 43 +- .../current/help/centos.md | 102 +-- .../current/help/clickhouse.md | 143 ++-- .../current/help/debian.md | 89 ++- .../current/help/dm.md | 54 +- .../current/help/dns.md | 36 +- .../current/help/docker.md | 92 ++- .../current/help/doris_fe.md | 124 ++-- .../current/help/dynamic_tp.md | 74 +- .../current/help/elasticsearch.md | 9 +- .../current/help/euleros.md | 19 +- .../current/help/flink.md | 6 +- .../current/help/flink_on_yarn.md | 238 +++--- .../current/help/freebsd.md | 15 +- .../current/help/ftp.md | 5 +- .../current/help/fullsite.md | 34 +- .../current/help/guide.md | 270 ++++--- .../current/help/hadoop.md | 75 +- .../current/help/hbase_master.md | 64 +- .../current/help/hbase_regionserver.md | 131 ++-- .../current/help/hdfs_datanode.md | 57 +- .../current/help/hdfs_namenode.md | 122 +-- .../current/help/hive.md | 64 +- .../current/help/huawei_switch.md | 107 +-- .../current/help/hugegraph.md | 213 +++--- .../current/help/imap.md | 7 +- .../current/help/influxdb.md | 68 +- .../current/help/influxdb_promql.md | 11 +- .../current/help/iotdb.md | 69 +- .../current/help/issue.md | 45 +- .../current/help/jetty.md | 73 +- .../current/help/jvm.md | 75 +- .../current/help/kafka.md | 92 ++- .../current/help/kafka_promql.md | 7 +- .../current/help/kubernetes.md | 77 +- .../current/help/linux.md | 102 +-- .../current/help/mariadb.md | 65 +- .../current/help/memcached.md | 5 +- .../current/help/mongodb.md | 16 +- .../current/help/mongodb_atlas.md | 104 ++- .../current/help/mysql.md | 65 +- .../current/help/nacos.md | 188 ++--- .../current/help/nebulagraph.md | 9 +- .../current/help/nebulagraph_cluster.md | 17 +- .../current/help/nginx.md | 67 +- .../current/help/ntp.md | 5 +- .../current/help/openai.md | 26 +- .../current/help/opengauss.md | 68 +- .../current/help/opensuse.md | 133 ++-- .../current/help/oracle.md | 77 +- .../current/help/ping.md | 33 +- .../current/help/plugin.md | 15 +- .../current/help/pop3.md | 28 +- .../current/help/port.md | 25 +- .../current/help/postgresql.md | 68 +- .../current/help/prestodb.md | 102 ++- .../current/help/process.md | 79 +- .../current/help/prometheus.md | 4 +- .../current/help/pulsar.md | 48 +- .../current/help/rabbitmq.md | 136 ++-- .../current/help/redhat.md | 19 +- .../current/help/redis.md | 401 +++++----- .../current/help/redis_cluster.md | 108 +-- .../current/help/rocketmq.md | 7 +- .../current/help/rockylinux.md | 19 +- .../current/help/shenyu.md | 111 ++- .../current/help/smtp.md | 6 +- .../current/help/spring_gateway.md | 68 +- .../current/help/springboot2.md | 60 +- .../current/help/springboot3.md | 23 +- .../current/help/sqlserver.md | 80 +- .../current/help/ssl_cert.md | 43 +- .../current/help/status.md | 40 +- .../current/help/tidb.md | 96 ++- .../current/help/time_expression.md | 15 +- .../current/help/tomcat.md | 80 +- .../current/help/ubuntu.md | 102 +-- .../current/help/udp_port.md | 5 +- .../current/help/website.md | 34 +- .../current/help/websocket.md | 5 +- .../current/help/windows.md | 43 +- .../current/help/yarn.md | 105 +-- .../current/help/zookeeper.md | 129 ++-- .../current/introduce.md | 27 +- .../current/others/design.md | 6 +- .../current/others/resource.md | 10 +- .../current/start/account-modify.md | 6 +- .../current/start/custom-config.md | 33 +- .../current/start/docker-compose-deploy.md | 21 +- .../current/start/docker-deploy.md | 29 +- .../current/start/greptime-init.md | 38 +- .../current/start/influxdb-init.md | 47 +- .../current/start/iotdb-init.md | 9 +- .../current/start/mysql-change.md | 35 +- .../current/start/package-deploy.md | 68 +- .../current/start/postgresql-change.md | 31 +- .../current/start/quickstart.md | 18 +- .../current/start/rainbond-deploy.md | 2 +- .../current/start/sslcert-practice.md | 4 - .../current/start/tdengine-init.md | 63 +- .../current/start/update-1.6.0.md | 27 +- .../current/start/upgrade.md | 16 +- .../current/start/victoria-metrics-init.md | 37 +- .../current/template.md | 24 +- .../advanced/extend-http-default.md | 24 +- .../advanced/extend-http-example-hertzbeat.md | 18 +- .../advanced/extend-http-example-token.md | 26 +- .../advanced/extend-http-jsonpath.md | 30 +- .../version-v1.4.x/advanced/extend-http.md | 23 +- .../version-v1.4.x/advanced/extend-jdbc.md | 53 +- .../version-v1.4.x/advanced/extend-jmx.md | 23 +- .../version-v1.4.x/advanced/extend-point.md | 13 +- .../version-v1.4.x/advanced/extend-snmp.md | 23 +- .../version-v1.4.x/advanced/extend-ssh.md | 47 +- .../advanced/extend-tutorial.md | 18 +- .../version-v1.4.x/help/activemq.md | 128 ++-- .../version-v1.4.x/help/airflow.md | 40 +- .../version-v1.4.x/help/alert_console.md | 4 +- .../version-v1.4.x/help/alert_dingtalk.md | 20 +- .../version-v1.4.x/help/alert_discord.md | 42 +- .../version-v1.4.x/help/alert_email.md | 31 +- .../help/alert_enterprise_wechat_app.md | 16 +- .../version-v1.4.x/help/alert_feishu.md | 22 +- .../version-v1.4.x/help/alert_slack.md | 27 +- .../version-v1.4.x/help/alert_telegram.md | 33 +- .../version-v1.4.x/help/alert_threshold.md | 26 +- .../help/alert_threshold_expr.md | 27 +- .../version-v1.4.x/help/alert_webhook.md | 46 +- .../version-v1.4.x/help/alert_wework.md | 28 +- .../version-v1.4.x/help/api.md | 39 +- .../version-v1.4.x/help/centos.md | 102 +-- .../version-v1.4.x/help/dm.md | 54 +- .../version-v1.4.x/help/docker.md | 92 ++- .../version-v1.4.x/help/dynamic_tp.md | 74 +- .../version-v1.4.x/help/fullsite.md | 34 +- .../version-v1.4.x/help/guide.md | 87 ++- .../version-v1.4.x/help/hadoop.md | 75 +- .../version-v1.4.x/help/hive.md | 64 +- .../version-v1.4.x/help/iotdb.md | 69 +- .../version-v1.4.x/help/issue.md | 50 +- .../version-v1.4.x/help/jetty.md | 73 +- .../version-v1.4.x/help/jvm.md | 75 +- .../version-v1.4.x/help/kafka.md | 92 ++- .../version-v1.4.x/help/kubernetes.md | 77 +- .../version-v1.4.x/help/linux.md | 102 +-- .../version-v1.4.x/help/mariadb.md | 65 +- .../version-v1.4.x/help/memcached.md | 9 +- .../version-v1.4.x/help/mysql.md | 65 +- .../version-v1.4.x/help/nebulagraph.md | 9 +- .../version-v1.4.x/help/nginx.md | 67 +- .../version-v1.4.x/help/ntp.md | 5 +- .../version-v1.4.x/help/opengauss.md | 68 +- .../version-v1.4.x/help/oracle.md | 77 +- .../version-v1.4.x/help/ping.md | 33 +- .../version-v1.4.x/help/pop3.md | 28 +- .../version-v1.4.x/help/port.md | 25 +- .../version-v1.4.x/help/postgresql.md | 68 +- .../version-v1.4.x/help/rabbitmq.md | 136 ++-- .../version-v1.4.x/help/redis.md | 401 +++++----- .../version-v1.4.x/help/shenyu.md | 111 ++- .../version-v1.4.x/help/smtp.md | 6 +- .../version-v1.4.x/help/spring_gateway.md | 68 +- .../version-v1.4.x/help/springboot2.md | 60 +- .../version-v1.4.x/help/sqlserver.md | 80 +- .../version-v1.4.x/help/ssl_cert.md | 43 +- .../version-v1.4.x/help/tomcat.md | 80 +- .../version-v1.4.x/help/ubuntu.md | 102 +-- .../version-v1.4.x/help/website.md | 34 +- .../version-v1.4.x/help/windows.md | 43 +- .../version-v1.4.x/help/zookeeper.md | 96 +-- .../version-v1.4.x/introduce.md | 27 +- .../version-v1.4.x/others/contact.md | 3 +- .../version-v1.4.x/others/contributing.md | 18 +- .../version-v1.4.x/others/design.md | 10 +- .../version-v1.4.x/others/developer.md | 447 ++++++----- .../version-v1.4.x/others/huaweicloud.md | 13 +- .../version-v1.4.x/others/images-deploy.md | 23 +- .../version-v1.4.x/others/resource.md | 12 +- .../version-v1.4.x/others/sponsor.md | 10 +- .../version-v1.4.x/start/account-modify.md | 6 +- .../version-v1.4.x/start/custom-config.md | 33 +- .../version-v1.4.x/start/docker-deploy.md | 117 ++- .../version-v1.4.x/start/greptime-init.md | 38 +- .../version-v1.4.x/start/influxdb-init.md | 47 +- .../version-v1.4.x/start/iotdb-init.md | 42 +- .../version-v1.4.x/start/mysql-change.md | 41 +- .../version-v1.4.x/start/package-deploy.md | 46 +- .../version-v1.4.x/start/postgresql-change.md | 23 +- .../version-v1.4.x/start/quickstart.md | 20 +- .../version-v1.4.x/start/rainbond-deploy.md | 2 +- .../version-v1.4.x/start/sslcert-practice.md | 3 - .../version-v1.4.x/start/tdengine-init.md | 65 +- .../version-v1.4.x/start/upgrade.md | 16 +- .../start/victoria-metrics-init.md | 37 +- .../version-v1.4.x/template.md | 24 +- .../advanced/extend-http-default.md | 24 +- .../advanced/extend-http-example-hertzbeat.md | 18 +- .../advanced/extend-http-example-token.md | 26 +- .../advanced/extend-http-jsonpath.md | 30 +- .../version-v1.5.x/advanced/extend-http.md | 23 +- .../version-v1.5.x/advanced/extend-jdbc.md | 53 +- .../version-v1.5.x/advanced/extend-jmx.md | 23 +- .../version-v1.5.x/advanced/extend-ngql.md | 8 +- .../version-v1.5.x/advanced/extend-point.md | 13 +- .../version-v1.5.x/advanced/extend-snmp.md | 23 +- .../version-v1.5.x/advanced/extend-ssh.md | 47 +- .../advanced/extend-tutorial.md | 18 +- .../community/become_committer.md | 30 +- .../community/become_pmc_member.md | 30 +- .../community/code-style-and-quality-guide.md | 638 ++++++++-------- .../version-v1.5.x/community/contact.md | 3 +- .../version-v1.5.x/community/contribution.md | 45 +- .../version-v1.5.x/community/development.md | 6 +- .../version-v1.5.x/community/document.md | 29 +- .../community/how-to-release.md | 53 +- .../version-v1.5.x/community/how-to-verify.md | 20 +- .../version-v1.5.x/community/mailing_lists.md | 42 +- .../community/new_committer_process.md | 30 +- .../community/new_pmc_member_process.md | 30 +- .../version-v1.5.x/community/submit-code.md | 80 +- .../version-v1.5.x/download.md | 9 +- .../version-v1.5.x/help/activemq.md | 128 ++-- .../version-v1.5.x/help/airflow.md | 40 +- .../version-v1.5.x/help/alert_console.md | 4 +- .../version-v1.5.x/help/alert_dingtalk.md | 20 +- .../version-v1.5.x/help/alert_discord.md | 42 +- .../version-v1.5.x/help/alert_email.md | 31 +- .../help/alert_enterprise_wechat_app.md | 16 +- .../version-v1.5.x/help/alert_feishu.md | 22 +- .../version-v1.5.x/help/alert_slack.md | 27 +- .../version-v1.5.x/help/alert_telegram.md | 33 +- .../version-v1.5.x/help/alert_threshold.md | 3 +- .../help/alert_threshold_expr.md | 33 +- .../version-v1.5.x/help/alert_webhook.md | 46 +- .../version-v1.5.x/help/alert_wework.md | 28 +- .../version-v1.5.x/help/almalinux.md | 141 ++-- .../version-v1.5.x/help/api.md | 43 +- .../version-v1.5.x/help/centos.md | 102 +-- .../version-v1.5.x/help/clickhouse.md | 143 ++-- .../version-v1.5.x/help/debian.md | 89 ++- .../version-v1.5.x/help/dm.md | 54 +- .../version-v1.5.x/help/dns.md | 36 +- .../version-v1.5.x/help/docker.md | 92 ++- .../version-v1.5.x/help/doris_fe.md | 124 ++-- .../version-v1.5.x/help/dynamic_tp.md | 74 +- .../version-v1.5.x/help/elasticsearch.md | 9 +- .../version-v1.5.x/help/euleros.md | 19 +- .../version-v1.5.x/help/flink.md | 6 +- .../version-v1.5.x/help/freebsd.md | 15 +- .../version-v1.5.x/help/ftp.md | 5 +- .../version-v1.5.x/help/fullsite.md | 34 +- .../version-v1.5.x/help/guide.md | 122 ++- .../version-v1.5.x/help/hadoop.md | 75 +- .../version-v1.5.x/help/hbase_master.md | 64 +- .../version-v1.5.x/help/hbase_regionserver.md | 131 ++-- .../version-v1.5.x/help/hdfs_datanode.md | 57 +- .../version-v1.5.x/help/hdfs_namenode.md | 122 +-- .../version-v1.5.x/help/hive.md | 64 +- .../version-v1.5.x/help/huawei_switch.md | 11 +- .../version-v1.5.x/help/hugegraph.md | 213 +++--- .../version-v1.5.x/help/influxdb.md | 68 +- .../version-v1.5.x/help/influxdb_promql.md | 11 +- .../version-v1.5.x/help/iotdb.md | 69 +- .../version-v1.5.x/help/issue.md | 45 +- .../version-v1.5.x/help/jetty.md | 73 +- .../version-v1.5.x/help/jvm.md | 75 +- .../version-v1.5.x/help/kafka.md | 92 ++- .../version-v1.5.x/help/kafka_promql.md | 7 +- .../version-v1.5.x/help/kubernetes.md | 77 +- .../version-v1.5.x/help/linux.md | 102 +-- .../version-v1.5.x/help/mariadb.md | 65 +- .../version-v1.5.x/help/memcached.md | 5 +- .../version-v1.5.x/help/mongodb.md | 16 +- .../version-v1.5.x/help/mysql.md | 65 +- .../version-v1.5.x/help/nacos.md | 114 +-- .../version-v1.5.x/help/nebulagraph.md | 9 +- .../help/nebulagraph_cluster.md | 17 +- .../version-v1.5.x/help/nginx.md | 67 +- .../version-v1.5.x/help/ntp.md | 5 +- .../version-v1.5.x/help/openai.md | 26 +- .../version-v1.5.x/help/opengauss.md | 68 +- .../version-v1.5.x/help/opensuse.md | 133 ++-- .../version-v1.5.x/help/oracle.md | 77 +- .../version-v1.5.x/help/ping.md | 33 +- .../version-v1.5.x/help/plugin.md | 13 +- .../version-v1.5.x/help/pop3.md | 28 +- .../version-v1.5.x/help/port.md | 25 +- .../version-v1.5.x/help/postgresql.md | 68 +- .../version-v1.5.x/help/process.md | 79 +- .../version-v1.5.x/help/prometheus.md | 4 +- .../version-v1.5.x/help/pulsar.md | 48 +- .../version-v1.5.x/help/rabbitmq.md | 136 ++-- .../version-v1.5.x/help/redhat.md | 19 +- .../version-v1.5.x/help/redis.md | 401 +++++----- .../version-v1.5.x/help/rocketmq.md | 7 +- .../version-v1.5.x/help/rockylinux.md | 19 +- .../version-v1.5.x/help/shenyu.md | 111 ++- .../version-v1.5.x/help/smtp.md | 6 +- .../version-v1.5.x/help/spring_gateway.md | 68 +- .../version-v1.5.x/help/springboot2.md | 60 +- .../version-v1.5.x/help/springboot3.md | 23 +- .../version-v1.5.x/help/sqlserver.md | 80 +- .../version-v1.5.x/help/ssl_cert.md | 43 +- .../version-v1.5.x/help/tidb.md | 50 +- .../version-v1.5.x/help/time_expression.md | 15 +- .../version-v1.5.x/help/tomcat.md | 80 +- .../version-v1.5.x/help/ubuntu.md | 102 +-- .../version-v1.5.x/help/udp_port.md | 5 +- .../version-v1.5.x/help/website.md | 34 +- .../version-v1.5.x/help/websocket.md | 5 +- .../version-v1.5.x/help/windows.md | 43 +- .../version-v1.5.x/help/yarn.md | 105 +-- .../version-v1.5.x/help/zookeeper.md | 96 +-- .../version-v1.5.x/introduce.md | 27 +- .../version-v1.5.x/others/design.md | 6 +- .../version-v1.5.x/others/resource.md | 10 +- .../version-v1.5.x/start/account-modify.md | 6 +- .../version-v1.5.x/start/custom-config.md | 33 +- .../version-v1.5.x/start/docker-deploy.md | 117 ++- .../version-v1.5.x/start/greptime-init.md | 38 +- .../version-v1.5.x/start/influxdb-init.md | 47 +- .../version-v1.5.x/start/iotdb-init.md | 9 +- .../version-v1.5.x/start/mysql-change.md | 41 +- .../version-v1.5.x/start/package-deploy.md | 48 +- .../version-v1.5.x/start/postgresql-change.md | 23 +- .../version-v1.5.x/start/quickstart.md | 20 +- .../version-v1.5.x/start/rainbond-deploy.md | 2 +- .../version-v1.5.x/start/sslcert-practice.md | 4 - .../version-v1.5.x/start/tdengine-init.md | 65 +- .../version-v1.5.x/start/upgrade.md | 16 +- .../start/victoria-metrics-init.md | 37 +- .../version-v1.5.x/template.md | 24 +- .../advanced/extend-http-default.md | 25 +- .../advanced/extend-http-example-hertzbeat.md | 18 +- .../advanced/extend-http-example-token.md | 15 +- .../advanced/extend-http-jsonpath.md | 28 +- .../version-v1.4.x/advanced/extend-http.md | 19 +- .../version-v1.4.x/advanced/extend-jdbc.md | 54 +- .../version-v1.4.x/advanced/extend-jmx.md | 12 +- .../version-v1.4.x/advanced/extend-point.md | 23 +- .../version-v1.4.x/advanced/extend-snmp.md | 11 +- .../version-v1.4.x/advanced/extend-ssh.md | 46 +- .../advanced/extend-tutorial.md | 16 +- .../version-v1.4.x/help/activemq.md | 129 ++-- .../version-v1.4.x/help/airflow.md | 40 +- .../version-v1.4.x/help/alert_console.md | 4 +- .../version-v1.4.x/help/alert_dingtalk.md | 20 +- .../version-v1.4.x/help/alert_discord.md | 8 +- .../version-v1.4.x/help/alert_email.md | 29 +- .../help/alert_enterprise_wechat_app.md | 18 +- .../version-v1.4.x/help/alert_feishu.md | 22 +- .../version-v1.4.x/help/alert_slack.md | 3 +- .../version-v1.4.x/help/alert_telegram.md | 3 +- .../version-v1.4.x/help/alert_threshold.md | 26 +- .../help/alert_threshold_expr.md | 27 +- .../version-v1.4.x/help/alert_webhook.md | 46 +- .../version-v1.4.x/help/alert_wework.md | 26 +- .../versioned_docs/version-v1.4.x/help/api.md | 42 +- .../version-v1.4.x/help/centos.md | 102 +-- home/versioned_docs/version-v1.4.x/help/dm.md | 54 +- .../version-v1.4.x/help/docker.md | 96 ++- .../version-v1.4.x/help/doris_be.md | 171 ++--- .../version-v1.4.x/help/doris_fe.md | 128 ++-- .../version-v1.4.x/help/dynamic_tp.md | 45 +- .../version-v1.4.x/help/fullsite.md | 41 +- .../version-v1.4.x/help/guide.md | 37 +- .../version-v1.4.x/help/hadoop.md | 13 +- .../version-v1.4.x/help/hive.md | 69 +- .../version-v1.4.x/help/iotdb.md | 45 +- .../version-v1.4.x/help/issue.md | 47 +- .../version-v1.4.x/help/jetty.md | 9 +- .../versioned_docs/version-v1.4.x/help/jvm.md | 8 +- .../version-v1.4.x/help/kafka.md | 92 ++- .../version-v1.4.x/help/kubernetes.md | 86 +-- .../version-v1.4.x/help/linux.md | 102 +-- .../version-v1.4.x/help/mariadb.md | 65 +- .../version-v1.4.x/help/memcached.md | 9 +- .../version-v1.4.x/help/mysql.md | 43 +- .../version-v1.4.x/help/nebulagraph.md | 9 +- .../version-v1.4.x/help/nginx.md | 46 +- .../versioned_docs/version-v1.4.x/help/ntp.md | 4 +- .../version-v1.4.x/help/opengauss.md | 70 +- .../version-v1.4.x/help/oracle.md | 53 +- .../version-v1.4.x/help/ping.md | 29 +- .../version-v1.4.x/help/pop3.md | 12 +- .../version-v1.4.x/help/port.md | 30 +- .../version-v1.4.x/help/postgresql.md | 68 +- .../version-v1.4.x/help/rabbitmq.md | 50 +- .../version-v1.4.x/help/redis.md | 401 +++++----- .../version-v1.4.x/help/shenyu.md | 103 ++- .../version-v1.4.x/help/smtp.md | 5 +- .../version-v1.4.x/help/spark.md | 19 +- .../version-v1.4.x/help/spring_gateway.md | 70 +- .../version-v1.4.x/help/springboot2.md | 61 +- .../version-v1.4.x/help/sqlserver.md | 70 +- .../version-v1.4.x/help/ssl_cert.md | 35 +- .../version-v1.4.x/help/tomcat.md | 75 +- .../version-v1.4.x/help/ubuntu.md | 102 +-- .../version-v1.4.x/help/website.md | 35 +- .../version-v1.4.x/help/windows.md | 43 +- .../version-v1.4.x/help/zookeeper.md | 97 +-- .../version-v1.4.x/introduce.md | 24 +- .../version-v1.4.x/others/contact.md | 3 +- .../version-v1.4.x/others/contributing.md | 22 +- .../version-v1.4.x/others/design.md | 10 +- .../version-v1.4.x/others/developer.md | 447 ++++++----- .../version-v1.4.x/others/hertzbeat.md | 59 +- .../version-v1.4.x/others/huaweicloud.md | 13 +- .../version-v1.4.x/others/images-deploy.md | 23 +- .../version-v1.4.x/others/resource.md | 12 +- .../version-v1.4.x/others/sponsor.md | 14 +- .../version-v1.4.x/start/account-modify.md | 5 +- .../version-v1.4.x/start/custom-config.md | 10 +- .../version-v1.4.x/start/docker-deploy.md | 111 +-- .../version-v1.4.x/start/greptime-init.md | 32 +- .../version-v1.4.x/start/influxdb-init.md | 53 +- .../version-v1.4.x/start/iotdb-init.md | 46 +- .../version-v1.4.x/start/mysql-change.md | 31 +- .../version-v1.4.x/start/package-deploy.md | 34 +- .../version-v1.4.x/start/postgresql-change.md | 15 +- .../version-v1.4.x/start/quickstart.md | 10 +- .../version-v1.4.x/start/rainbond-deploy.md | 2 +- .../version-v1.4.x/start/sslcert-practice.md | 12 - .../version-v1.4.x/start/tdengine-init.md | 88 ++- .../version-v1.4.x/start/upgrade.md | 17 +- .../start/victoria-metrics-init.md | 33 +- .../versioned_docs/version-v1.4.x/template.md | 24 +- .../advanced/extend-http-default.md | 25 +- .../advanced/extend-http-example-hertzbeat.md | 18 +- .../advanced/extend-http-example-token.md | 15 +- .../advanced/extend-http-jsonpath.md | 28 +- .../version-v1.5.x/advanced/extend-http.md | 19 +- .../version-v1.5.x/advanced/extend-jdbc.md | 54 +- .../version-v1.5.x/advanced/extend-jmx.md | 12 +- .../version-v1.5.x/advanced/extend-ngql.md | 8 +- .../version-v1.5.x/advanced/extend-point.md | 23 +- .../version-v1.5.x/advanced/extend-snmp.md | 11 +- .../version-v1.5.x/advanced/extend-ssh.md | 46 +- .../advanced/extend-tutorial.md | 16 +- .../community/become_committer.md | 30 +- .../community/become_pmc_member.md | 30 +- .../community/code-style-and-quality-guide.md | 700 +++++++++--------- .../version-v1.5.x/community/contact.md | 2 +- .../version-v1.5.x/community/contribution.md | 47 +- .../version-v1.5.x/community/development.md | 8 +- .../version-v1.5.x/community/document.md | 29 +- .../community/how-to-release.md | 52 +- .../version-v1.5.x/community/how-to-verify.md | 17 +- .../version-v1.5.x/community/mailing_lists.md | 41 +- .../community/new_committer_process.md | 36 +- .../community/new_pmc_member_process.md | 30 +- .../version-v1.5.x/community/submit-code.md | 68 +- .../versioned_docs/version-v1.5.x/download.md | 5 +- .../version-v1.5.x/help/activemq.md | 129 ++-- .../version-v1.5.x/help/airflow.md | 40 +- .../version-v1.5.x/help/alert_console.md | 4 +- .../version-v1.5.x/help/alert_dingtalk.md | 20 +- .../version-v1.5.x/help/alert_discord.md | 8 +- .../version-v1.5.x/help/alert_email.md | 29 +- .../help/alert_enterprise_wechat_app.md | 18 +- .../version-v1.5.x/help/alert_feishu.md | 22 +- .../version-v1.5.x/help/alert_slack.md | 3 +- .../version-v1.5.x/help/alert_telegram.md | 3 +- .../version-v1.5.x/help/alert_threshold.md | 1 + .../help/alert_threshold_expr.md | 64 +- .../version-v1.5.x/help/alert_webhook.md | 46 +- .../version-v1.5.x/help/alert_wework.md | 26 +- .../version-v1.5.x/help/almalinux.md | 43 +- .../versioned_docs/version-v1.5.x/help/api.md | 46 +- .../version-v1.5.x/help/centos.md | 102 +-- .../version-v1.5.x/help/clickhouse.md | 142 ++-- .../version-v1.5.x/help/debian.md | 27 +- home/versioned_docs/version-v1.5.x/help/dm.md | 54 +- .../versioned_docs/version-v1.5.x/help/dns.md | 13 +- .../version-v1.5.x/help/docker.md | 96 ++- .../version-v1.5.x/help/doris_be.md | 171 ++--- .../version-v1.5.x/help/doris_fe.md | 75 +- .../version-v1.5.x/help/dynamic_tp.md | 45 +- .../version-v1.5.x/help/elasticsearch.md | 7 +- .../version-v1.5.x/help/euleros.md | 13 +- .../version-v1.5.x/help/flink.md | 19 +- .../version-v1.5.x/help/freebsd.md | 7 +- .../versioned_docs/version-v1.5.x/help/ftp.md | 5 +- .../version-v1.5.x/help/fullsite.md | 41 +- .../version-v1.5.x/help/guide.md | 37 +- .../version-v1.5.x/help/hadoop.md | 13 +- .../version-v1.5.x/help/hbase_master.md | 24 +- .../version-v1.5.x/help/hbase_regionserver.md | 26 +- .../version-v1.5.x/help/hdfs_datanode.md | 55 +- .../version-v1.5.x/help/hdfs_namenode.md | 121 +-- .../version-v1.5.x/help/hive.md | 69 +- .../version-v1.5.x/help/http_sd.md | 26 +- .../version-v1.5.x/help/huawei_switch.md | 11 +- .../version-v1.5.x/help/hugegraph.md | 235 +++--- .../version-v1.5.x/help/influxdb.md | 77 +- .../version-v1.5.x/help/influxdb_promql.md | 11 +- .../version-v1.5.x/help/iotdb.md | 45 +- .../version-v1.5.x/help/issue.md | 45 +- .../version-v1.5.x/help/jetty.md | 9 +- .../versioned_docs/version-v1.5.x/help/jvm.md | 8 +- .../version-v1.5.x/help/kafka.md | 92 ++- .../version-v1.5.x/help/kafka_promql.md | 9 +- .../version-v1.5.x/help/kubernetes.md | 86 +-- .../version-v1.5.x/help/linux.md | 102 +-- .../version-v1.5.x/help/mariadb.md | 65 +- .../version-v1.5.x/help/memcached.md | 9 +- .../version-v1.5.x/help/mongodb.md | 16 +- .../version-v1.5.x/help/mysql.md | 43 +- .../version-v1.5.x/help/nacos.md | 114 +-- .../version-v1.5.x/help/nebulagraph.md | 9 +- .../help/nebulagraph_cluster.md | 11 +- .../version-v1.5.x/help/nginx.md | 46 +- .../versioned_docs/version-v1.5.x/help/ntp.md | 4 +- .../version-v1.5.x/help/openai.md | 10 +- .../version-v1.5.x/help/opengauss.md | 70 +- .../version-v1.5.x/help/opensuse.md | 130 ++-- .../version-v1.5.x/help/oracle.md | 53 +- .../version-v1.5.x/help/ping.md | 29 +- .../version-v1.5.x/help/plugin.md | 5 +- .../version-v1.5.x/help/pop3.md | 12 +- .../version-v1.5.x/help/port.md | 30 +- .../version-v1.5.x/help/postgresql.md | 68 +- .../version-v1.5.x/help/process.md | 45 +- .../version-v1.5.x/help/prometheus.md | 4 +- .../version-v1.5.x/help/pulsar.md | 46 +- .../version-v1.5.x/help/rabbitmq.md | 50 +- .../version-v1.5.x/help/redhat.md | 13 +- .../version-v1.5.x/help/redis.md | 401 +++++----- .../version-v1.5.x/help/rocketmq.md | 7 +- .../version-v1.5.x/help/rockylinux.md | 13 +- .../version-v1.5.x/help/shenyu.md | 103 ++- .../version-v1.5.x/help/smtp.md | 5 +- .../version-v1.5.x/help/spark.md | 19 +- .../version-v1.5.x/help/spring_gateway.md | 70 +- .../version-v1.5.x/help/springboot2.md | 61 +- .../version-v1.5.x/help/springboot3.md | 13 +- .../version-v1.5.x/help/sqlserver.md | 70 +- .../version-v1.5.x/help/ssl_cert.md | 35 +- .../version-v1.5.x/help/tidb.md | 50 +- .../version-v1.5.x/help/time_expression.md | 41 +- .../version-v1.5.x/help/tomcat.md | 75 +- .../version-v1.5.x/help/ubuntu.md | 102 +-- .../version-v1.5.x/help/udp_port.md | 6 +- .../version-v1.5.x/help/website.md | 35 +- .../version-v1.5.x/help/websocket.md | 5 +- .../version-v1.5.x/help/windows.md | 43 +- .../version-v1.5.x/help/yarn.md | 103 +-- .../version-v1.5.x/help/zookeeper.md | 97 +-- .../version-v1.5.x/introduce.md | 24 +- .../version-v1.5.x/others/design.md | 6 +- .../version-v1.5.x/others/resource.md | 16 +- .../version-v1.5.x/start/account-modify.md | 11 +- .../version-v1.5.x/start/custom-config.md | 10 +- .../version-v1.5.x/start/docker-deploy.md | 111 +-- .../version-v1.5.x/start/greptime-init.md | 32 +- .../version-v1.5.x/start/influxdb-init.md | 54 +- .../version-v1.5.x/start/iotdb-init.md | 7 +- .../version-v1.5.x/start/mysql-change.md | 32 +- .../version-v1.5.x/start/package-deploy.md | 31 +- .../version-v1.5.x/start/postgresql-change.md | 15 +- .../version-v1.5.x/start/quickstart.md | 10 +- .../version-v1.5.x/start/rainbond-deploy.md | 2 +- .../version-v1.5.x/start/sslcert-practice.md | 13 - .../version-v1.5.x/start/tdengine-init.md | 88 ++- .../version-v1.5.x/start/upgrade.md | 17 +- .../start/victoria-metrics-init.md | 32 +- .../versioned_docs/version-v1.5.x/template.md | 24 +- pom.xml | 2 +- 688 files changed, 16627 insertions(+), 16863 deletions(-) diff --git a/home/README.md b/home/README.md index ae1b5ccb71e..0904a4af224 100644 --- a/home/README.md +++ b/home/README.md @@ -1,6 +1,6 @@ # HertzBeat Website -This website is built with [Docusaurus](https://docusaurus.io/). +This website is built with [Docusaurus](https://docusaurus.io/). ## Installation @@ -55,7 +55,6 @@ GITHUB_HOST=gitee.com USE_SSH=true yarn deploy yarn docusaurus docs:version v1.5.x ``` - ## Directory Structure ```html @@ -85,3 +84,4 @@ yarn docusaurus docs:version v1.5.x |-- docusaurus.config.js |-- sidebars.js // document sidebar menu configuration ``` + diff --git a/home/blog/2022-06-01-hertzbeat-v1.0.md b/home/blog/2022-06-01-hertzbeat-v1.0.md index 8350ddb5825..8338eb93a57 100644 --- a/home/blog/2022-06-01-hertzbeat-v1.0.md +++ b/home/blog/2022-06-01-hertzbeat-v1.0.md @@ -4,7 +4,7 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- HertzBeat, incubated by Dromara and open-sourced by TanCloud, is an open-source monitoring and alerting project that supports a variety of monitoring types including websites, APIs, PING, ports, databases, full-site, operating systems, middleware, etc. It supports threshold alarms and notification alerts (email, webhook, DingTalk, WeCom, Feishu robots) and has an easy-to-use, friendly visual operation interface. @@ -66,16 +66,15 @@ Redis monitor is coming： > [HertzBeat](https://github.com/apache/hertzbeat), incubated by [Dromara](https://dromara.org) and open-sourced by [TanCloud](https://tancloud.cn), is an open-source monitoring and alerting project with a user-friendly visual interface that supports monitoring types such as websites, APIs, PING, ports, databases, operating systems, and more. > Of course, we also provide a corresponding [SaaS cloud monitoring version](https://console.tancloud.cn), so small and medium-sized teams and individuals no longer need to deploy a cumbersome monitoring system to monitor their website resources; you can [log in](https://console.tancloud.cn) to start monitoring for free. - +> > HertzBeat supports custom monitoring; by configuring the YML file, we can customize the required monitoring types and metrics to meet common personalized needs. > HertzBeat is modular, with manager, collector, scheduler, warehouse, alerter modules decoupled, making it easy to understand and customize for development. > HertzBeat supports more flexible alarm configurations (calculation expressions), supports alarm notifications, alarm templates, and timely delivery of notifications via email, DingTalk, WeChat, Feishu, etc. > Feel free to log in to HertzBeat's cloud environment, [TanCloud](https://console.tancloud.cn), to try it out and discover more. > We are rapidly iterating and welcome participation in joining and contributing to the open-source ecosystem. - +> > The multi-type support, easy expansion, and low coupling of `HertzBeat` aim to help developers and small to medium-sized teams quickly build their own monitoring systems. - **Repository url** [Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat diff --git a/home/blog/2022-06-19-hertzbeat-v1.1.0.md b/home/blog/2022-06-19-hertzbeat-v1.1.0.md index 669cd8fc1a0..cbc3102db5c 100644 --- a/home/blog/2022-06-19-hertzbeat-v1.1.0.md +++ b/home/blog/2022-06-19-hertzbeat-v1.1.0.md @@ -35,7 +35,7 @@ Bugfixes: Online at https://console.tancloud.cn. ------------------------ +--- Windows Monitor coming： ![2022-06-19 11:30:57](https://user-images.githubusercontent.com/24788200/174481159-b8a73c87-aff5-4c4c-befb-bd0d26685d71.png) @@ -54,13 +54,14 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` +``` Have Fun! ---- ## V1.1.0 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. @@ -75,7 +76,7 @@ Feature： 2. [[monitor]change default database mysql to h2 #191](https://github.com/apache/hertzbeat/pull/191) 3. [[manager]support monitor params name i18n #184](https://github.com/apache/hertzbeat/pull/184). 4. [[script]build multi cpu arch hertzbeat docker version #189](https://github.com/apache/hertzbeat/pull/189). -5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time +5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time 6. [[monitor]database tables append prefix hzb_ #193](https://github.com/apache/hertzbeat/pull/193) issue from @shimingxy Bugfix. @@ -87,12 +88,12 @@ Bugfix. Online https://console.tancloud.cn. ------------------------ +--- + Windows Monitor coming： 2022-06-19 11 30 57 - ⚠️ ⚠️⚠️⚠️Attention other version upgrade to v1.1.0 need run sql script. Now the tables name has hzb_ prefix. ``` @@ -107,12 +108,10 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` +``` Have Fun! - - Have Fun! ---- @@ -124,7 +123,7 @@ Have Fun! > HertzBeat supports more flexible alarm configurations (calculation expressions), notification alerts, templates, and real-time delivery via email, DingTalk, WeChat, Lark, etc. > Welcome to try and discover more in HertzBeat's [cloud environment TanCloud](https://console.tancloud.cn). > We are rapidly iterating and welcome participation to join in co-building the open-source ecosystem. - +> > HertzBeat's support for multiple types, easy expansion, and low coupling hopes to help developers and small and medium teams quickly build their own monitoring systems. **Repository Addresses** diff --git a/home/blog/2022-06-22-one-step-up.md b/home/blog/2022-06-22-one-step-up.md index 59518f2e679..9c60d422482 100644 --- a/home/blog/2022-06-22-one-step-up.md +++ b/home/blog/2022-06-22-one-step-up.md @@ -35,7 +35,7 @@ Bugfixes: Online at [https://console.tancloud.cn](https://console.tancloud.cn). ------------------------ +--- Windows Monitor is coming: ![2022-06-19 11:30:57](https://user-images.githubusercontent.com/24788200/174481159-b8a73c87-aff5-4c4c-befb-bd0d26685d71.png) @@ -54,13 +54,14 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` +``` Have Fun! ---- ## V1.1.0 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. @@ -75,7 +76,7 @@ Feature： 2. [[monitor]change default database mysql to h2 #191](https://github.com/apache/hertzbeat/pull/191) 3. [[manager]support monitor params name i18n #184](https://github.com/apache/hertzbeat/pull/184). 4. [[script]build multi cpu arch hertzbeat docker version #189](https://github.com/apache/hertzbeat/pull/189). -5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time +5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time 6. [[monitor]database tables append prefix hzb_ #193](https://github.com/apache/hertzbeat/pull/193) issue from @shimingxy Bugfix. @@ -87,12 +88,12 @@ Bugfix. Online https://console.tancloud.cn. ------------------------ +--- + Windows Monitor coming： 2022-06-19 11 30 57 - ⚠️ ⚠️⚠️⚠️Attention other version upgrade to v1.1.0 need run sql script. Now the tables name has hzb_ prefix. ``` @@ -107,7 +108,7 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` +``` Have Fun! @@ -120,7 +121,7 @@ Have Fun! > HertzBeat supports more flexible alarm configurations (calculation expressions) and alarm notifications, including alarm templates, emails, DingTalk, WeChat, Feishu, etc., for timely delivery of notifications. > Welcome to log in to HertzBeat's [cloud environment TanCloud](https://console.tancloud.cn) to try and discover more. > We are in rapid iteration and welcome participation in co-building the open-source ecosystem. - +> > HertzBeat's support for multiple types, easy expansion, and low coupling aims to help developers and small and medium teams quickly build their own monitoring systems. **Repository Addresses** diff --git a/home/blog/2022-07-10-hertzbeat-v1.1.1.md b/home/blog/2022-07-10-hertzbeat-v1.1.1.md index 7139cbfd0a4..c4a87a40c3d 100644 --- a/home/blog/2022-07-10-hertzbeat-v1.1.1.md +++ b/home/blog/2022-07-10-hertzbeat-v1.1.1.md @@ -4,12 +4,12 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- > Friendly Cloud Monitoring Tool. | 易用友好的实时监控工具, 无需Agent, 强大自定义监控能力. -**Home: [hertzbeat.com](https://hertzbeat.com)** +**Home: [hertzbeat.com](https://hertzbeat.com)** Hi guys! HertzBeat v1.1.1 is coming. This version brings custom monitoring enhancements, and the collected metric data can be assigned as a variable to the next collection. Fixed several bugs and improved the overall stable usability. @@ -24,7 +24,7 @@ Feature： 2. [[monitor] support use pre collect metrics data to replace next metrics config params #206](https://github.com/apache/hertzbeat/pull/206). 3. [[collector] use basic auth with raw HTTP headers instead of preemptive #212](https://github.com/apache/hertzbeat/pull/212) 4. [[manager,alerter] support wework, dingDing, flyBook webhook url config #213](https://github.com/apache/hertzbeat/pull/213) -5. [[monitor] feature update numeric metrics all contain decimal points #217](https://github.com/apache/hertzbeat/pull/217) +5. [[monitor] feature update numeric metrics all contain decimal points #217](https://github.com/apache/hertzbeat/pull/217) 6. [[web-app]feature:toggle [enable and cancel] button #218](https://github.com/apache/hertzbeat/pull/218) 7. [[manager] update define yml file name add prefix "app" or "param" #221](https://github.com/apache/hertzbeat/pull/221) @@ -53,7 +53,7 @@ Have Fun! > HertzBeat is modular, `manager, collector, scheduler, warehouse, alerter` modules are decoupled for easy understanding and custom development. > Welcome to HertzBeat's [Cloud Environment TanCloud](https://console.tancloud.cn) to try and discover more. > Welcome to join us to build hertzbeat together. - +> > `HertzBeat`'s multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring tool. **If you like HertzBeat, star us on GitHub** diff --git a/home/blog/2022-09-04-hertzbeat-v1.1.3.md b/home/blog/2022-09-04-hertzbeat-v1.1.3.md index b4076083e8b..3cec823079b 100644 --- a/home/blog/2022-09-04-hertzbeat-v1.1.3.md +++ b/home/blog/2022-09-04-hertzbeat-v1.1.3.md @@ -4,9 +4,11 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- + ## V1.1.3 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.1.3 is coming. This version supports kafka monitor, ssl certificate expired monitor and more. Fixed several bugs and improved the overall stable usability. @@ -22,9 +24,9 @@ Feature： 2. [[monitor] feature: support apache kafka monitor #263](https://github.com/apache/hertzbeat/pull/263) contribute by @wang1027-wqh 3. [[webapp] support history chart query 3 mouth time range #265](https://github.com/apache/hertzbeat/pull/265) issue by @ericfrol 4. [[monitor] support ssl certificate expired monitor #266](https://github.com/apache/hertzbeat/pull/266) suggest by @noear -5. [[web-app] update default interval 600s to 120s #268](https://github.com/apache/hertzbeat/pull/268) -6. [[web-app] update layout ui - help button, nav menu #272](https://github.com/apache/hertzbeat/pull/272) -7. [[alert,webapp] support delete all alerts at once. #273](https://github.com/apache/hertzbeat/pull/273) issue by @ericfrol +5. [[web-app] update default interval 600s to 120s #268](https://github.com/apache/hertzbeat/pull/268) +6. [[web-app] update layout ui - help button, nav menu #272](https://github.com/apache/hertzbeat/pull/272) +7. [[alert,webapp] support delete all alerts at once. #273](https://github.com/apache/hertzbeat/pull/273) issue by @ericfrol 8. [[web-app] update home background image #276](https://github.com/apache/hertzbeat/pull/276) Bugfix. @@ -37,4 +39,5 @@ Bugfix. Online https://console.tancloud.cn. Have Fun! ----- +--------- + diff --git a/home/blog/2022-09-10-ssl-practice.md b/home/blog/2022-09-10-ssl-practice.md index e0bd7337753..5c0525f8c16 100644 --- a/home/blog/2022-09-10-ssl-practice.md +++ b/home/blog/2022-09-10-ssl-practice.md @@ -4,7 +4,7 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource, practice] +tags: [opensource, practice] --- First of all, I would like to wish all the students who see it a happy mid-autumn festival, good health, and try to get rich on the basis of good health. @@ -38,7 +38,6 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > System Page -> Monitor Menu -> SSL Certificates -> New SSL Certificate - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd53f343a5b54feab62e71458d076441~tplv-k3u1fbpfcp-zoom-1.image) 2. Configure monitoring website @@ -52,52 +51,38 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > You can view the task status in the monitor list, and go into the monitor details to view the metrics data graphs etc. - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f874b45e909c4bb0acdd28b3fb034a61~tplv-k3u1fbpfcp-zoom-1.image) - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ef5d7443f8c04818ae5aa28d421203be~tplv-k3u1fbpfcp-zoom-1.image) - - 4. Set the threshold (triggered when the certificate expires) > System Page -> Alarms -> Alarm Thresholds -> Add Thresholds - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d6205172d43463aa34e534477f132f1~tplv-k3u1fbpfcp-zoom-1.image) > Configure thresholds, select SSL certificate indicator object, configure alert expression - triggered when indicator `expired` is `true`, i.e. `equals(expired, "true")` , set alert level notification template message etc. - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/83d17b381d994f26a6240e01915b2001~tplv-k3u1fbpfcp-zoom-1.image) > Associate thresholds with monitors, set which monitors this threshold should be applied to in the threshold list. - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9b9063d7bcf9454387be0491fc382bd1~tplv-k3u1fbpfcp-zoom-1.image) - - - 5. set the threshold (triggered one week before certificate expiration) > Same as above, add a new configuration threshold, configure the alert expression - when the indicator validity timestamp `end_timestamp`, `now()` function for the current timestamp, if you configure to trigger the alert one week in advance i.e.: `end_timestamp <= (now() + 604800000)` , where `604800000` is the total time difference of 7 days. milliseconds. - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0d6f837f57c247e09f668f60eff4a0ff~tplv-k3u1fbpfcp-zoom-1.image) > Eventually you can see the triggered alarms in the alarm center. - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5a61b23127524976b2c209ce0ca6a339~tplv-k3u1fbpfcp-zoom-1.image) - 6. Alarm notification (timely notification via NailWeChatFlysheet, etc.) > Monitoring System -> Alert Notification -> Add Recipients - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7f36956060ef410a82bbecafcbb2957f~tplv-k3u1fbpfcp-zoom-1.image) You can refer to the help file for the token configuration of Nail WeChat Flying Book, etc. @@ -107,7 +92,6 @@ https://tancloud.cn/docs/help/alert_dingtalk > Alert Notification -> Add new alert notification policy -> Enable notification for the recipients you just configured - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d976343e81f843138344a039f3aff8a3~tplv-k3u1fbpfcp-zoom-1.image) 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. diff --git a/home/blog/2022-10-08-hertzbeat-v1.2.0.md b/home/blog/2022-10-08-hertzbeat-v1.2.0.md index 90e88793232..7137abeb7ca 100644 --- a/home/blog/2022-10-08-hertzbeat-v1.2.0.md +++ b/home/blog/2022-10-08-hertzbeat-v1.2.0.md @@ -58,13 +58,15 @@ Have Fun! ### Upgrade ⚠️ Need Convert `application.yml`. + ``` spring. resources: static-locations. static-locations. - classpath:/dist/ - classpath:... /dist/ -``` +``` + To `` spring. @@ -73,6 +75,9 @@ resources: static-locations. static-locations. - classpath:/dist/ - classpath:... /dist/ + ``` ---- +``` + diff --git a/home/blog/2022-11-28-hertzbeat-v1.2.2.md b/home/blog/2022-11-28-hertzbeat-v1.2.2.md index b546c676773..be3b0b5bc75 100644 --- a/home/blog/2022-11-28-hertzbeat-v1.2.2.md +++ b/home/blog/2022-11-28-hertzbeat-v1.2.2.md @@ -8,6 +8,7 @@ tags: [opensource] --- ## v1.2.2 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernetes, docker, springboot, nacos and database dm, opengauss and more. Also we bring an experimental feature, users can custom define metrics collect from prometheus with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage metrics. @@ -40,7 +41,6 @@ Feature： 16. [[hertzbeat] update use PromQL to collect metrics from prometheus server #456](https://github.com/apache/hertzbeat/pull/456) 17. [[manager] support custom monitor api response data code #460](https://github.com/apache/hertzbeat/pull/460) - Bugfix. 1. [【bugfix#408】if logs dir not exist, create logs dir #409](https://github.com/apache/hertzbeat/pull/409) @Ceilzcx @@ -58,6 +58,7 @@ Have Fun! ---- ## V1.2.2 + 官网: hertzbeat.com | tancloud.cn 大家好，HertzBeat v1.2.2发布啦！这个版本带来个超多重大更新，我们支持了对云原生kubernets, docker的监控，支持了对springboot应用, nacos注册发现中心，达梦数据库，opengauss数据库等的指标监控。我们也引入了一个实验性特性，用户可以使用promethues promql 从promethues server拿取指标数据作为hertzbeat自定义监控指标数据。当然我们也新增了多个测试用户覆盖，修复了多个BUG。还有个很多用户想要的更新，我们新增了对linux监控的top10 cpu 内存利用率的进程监控指标。有个这个指标，我们就可以干很多事情。比如监控某个进程CPU异常，内存爆满啥的。快来试试吧！ @@ -75,8 +76,8 @@ Feature： 2. [[home] add DM db document supplement #411](https://github.com/apache/hertzbeat/pull/411) @TJxiaobao 3. [[home] support algolia search #416](https://github.com/apache/hertzbeat/pull/416) 4. [[collector] support trigger and grading multiple subtasks through -_- placeholder expression #418](https://github.com/apache/hertzbeat/pull/418) -5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu -6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422) +5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu +6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422) 7. [[#406][warehose] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan 8. [[#358][manager] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan 9. [[#356][manager] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu @@ -89,7 +90,6 @@ Feature： 16. [[hertzbeat] update use PromQL to collect metrics from prometheus server #456](https://github.com/apache/hertzbeat/pull/456) 17. [[manager] support custom monitor api response data code #460](https://github.com/apache/hertzbeat/pull/460) - Bugfix. 1. [【bugfix#408】if logs dir not exist, create logs dir #409](https://github.com/apache/hertzbeat/pull/409) @Ceilzcx @@ -101,3 +101,4 @@ Bugfix. 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear ---- + diff --git a/home/blog/2022-12-19-new-committer.md b/home/blog/2022-12-19-new-committer.md index 04a7e28d849..34df92ffbd4 100644 --- a/home/blog/2022-12-19-new-committer.md +++ b/home/blog/2022-12-19-new-committer.md @@ -9,7 +9,6 @@ tags: [opensource] > 非常高兴 HertzBeat 迎来了两位新晋社区Committer, 两位都是来自互联网公司的开发工程师，让我们来了解下他们的开源经历吧！ - ## 第一位 花城 姓名：王庆华 @@ -25,18 +24,18 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh) 说起来挺偶然的，结识hertzbeat是因为我大学的毕业设计，当时在一家互联网公司实习，那个时候第一次看到了企业是怎么监控项目的，不管是系统监控、业务监控还是物联网iot监控，那个时候见世面不广，只知道Prometheus + Grafana，但是学起来、用起来成本比较高，那个时候就觉得应该有其他类型的监控，恰好，到了大学毕业设计选题，我就开始寻找这方面的开源项目，那个时候我们小组正在使用Shen Yu网关，我就看了下社区，发现了hertzbeat，自此我便于它结缘了。 ## 开始提交PR + 到了2022-02-18 我开始提交了我第一个pr，当时只是为了优化一些controller入参的格式，没有什么技术含量，但是这是我接触开源的第一步，让我在从理论学习跨出了实践的一步 ## 持续的开源贡献与收获 到目前为止，参与hertzbeat开源项目已有半年多时间，贡献了许多，也成长收获了许多。具体如下： -1. 见证了hertzbeat的贡献值从0到1 -2. 兼容了zookeeper、JVM、Kafka等监控功能 -3. 实现了hertzbeat项目的国际化 -4. 参与了开源之夏并顺利结项 -5. 增加了监控系统的基础告警功能: 钉钉、飞书、企业微信、邮箱等 - +1. 见证了hertzbeat的贡献值从0到1 +2. 兼容了zookeeper、JVM、Kafka等监控功能 +3. 实现了hertzbeat项目的国际化 +4. 参与了开源之夏并顺利结项 +5. 增加了监控系统的基础告警功能: 钉钉、飞书、企业微信、邮箱等 ## 感谢社区小伙伴 @@ -44,14 +43,13 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh) ## 对新人的一点建议 -1. 不要觉得自己一上手就能接触到核心，心急吃不了热豆腐 -2. 不要只注重看代码，要上手搭建、使用 -3. 有想法就大胆尝试，不管自己的方案是否完善 -4. 多多关注开源，了解社区动态，多和开源开发者交流 - +1. 不要觉得自己一上手就能接触到核心，心急吃不了热豆腐 +2. 不要只注重看代码，要上手搭建、使用 +3. 有想法就大胆尝试，不管自己的方案是否完善 +4. 多多关注开源，了解社区动态，多和开源开发者交流 ------ ------ +--- +--- ## 第二位 星辰 @@ -65,13 +63,10 @@ Hertzbeat Committer github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) - ## 初识Hertzbeat 2022年8月开始接触Hertzbeat，由于公司监控elasticsearch使用的cerebro，虽然有非常强大的数据监控，但缺少告警通知的功能；就去github上浏览监控类的项目，刚好看到Hertzbeat，对此非常感兴趣，在了解完整个项目结构和实现后，刚好elasticsearch的监控部分做的不够完善，我就根据cerebro完善了这部分监控数据并提交了pull request。后面在tom老哥的帮助下也开始其他部分的实现。 - - ## 开始提交PR 从2022年9月至今提交了好几个pr，主要包括： @@ -83,8 +78,6 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) + 一些bug的修复。。。 + promethues exporter 协议解析 - - ## 持续的开源贡献与收获 到目前为止，参与Hertzbeat社区开源已有半年多时间，贡献了许多，也成长收获了许多。 @@ -93,19 +86,16 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) 同时在社区群里，看到别人提的问题和帮助别人可以学到很多新的知识，很多问题你目前不一定会遇到，其他人遇到的时候你可以思考并收获很多知识。 - ## 感谢社区小伙伴 感谢无偿帮助过我或给过我启发的小伙伴：[tomsun28](https://github.com/tomsun28) - ## 对新人的一点建议 + 使用者可以先看官网，官网基本能够解决你的问题。部分简单或者常见的问题其他可以自己解决，对自己也是一种锻炼 + 可以尝试阅读源码，大部分源码都是包含注释的，并不难；不懂的地方也可以通过运行test，debug看一下整个流程 + 有想法或者bug，可以前往gitee或者github提交issues，也可以在群里询问，不要怕，都是从菜逼过来的 - ## 如何参与Hertzbeat + 官网有非常完善的贡献者指南：[贡献者指南 | HertzBeat](https://hertzbeat.com/docs/community/contribution) @@ -114,5 +104,5 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) + 如果是大的改动，建议提交前编写issues，在提交pr，同时请注意编码的规范，尽量减少bug和警告的产生 - > 以上就是我们新晋Committer们的开源经历了，可以看出参与开源并不难，更重要的是迈出第一步，无论是代码还是文档修复或者提交issue，这些都是贡献者参与开源的姿势。快来加入我们吧！ + diff --git a/home/blog/2022-12-28-hertzbeat-v1.2.3.md b/home/blog/2022-12-28-hertzbeat-v1.2.3.md index f818dc5e878..40af1be10bf 100644 --- a/home/blog/2022-12-28-hertzbeat-v1.2.3.md +++ b/home/blog/2022-12-28-hertzbeat-v1.2.3.md @@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource] --- -## v1.2.3 +## v1.2.3 Home: hertzbeat.com | tancloud.cn @@ -38,7 +38,6 @@ Feature： 12. [add Prometheus exporter metrics parser and IoTDB monitor #505](https://github.com/apache/hertzbeat/pull/505) @Ceilzcx 13. [support apache shenyu metrics monitoring #507](https://github.com/apache/hertzbeat/pull/507) - Bugfix. 1. [[manager] fix cross domain problem in SecurityCorsConfiguration #469](https://github.com/apache/hertzbeat/pull/469) @zenan08 @@ -57,6 +56,7 @@ Have Fun! ---- ## V1.2.3 + 官网: hertzbeat.com | tancloud.cn 大家好，HertzBeat v1.2.3发布啦！这个版本带来了重大更新，我们支持了对prometheus exporter协议监控，用户可以很方便的使用hertzbeat来适配监控prometheus exporter. 基于这个能力，这个版本我们也支持了对apache shenyu, apache iotdb的指标监控。我们更新了UI布局，修复了多个BUG，也支持了短信通知。快来体验下吧! @@ -84,7 +84,6 @@ Feature： 12. [add Prometheus exporter metrics parser and IoTDB monitor #505](https://github.com/apache/hertzbeat/pull/505) @Ceilzcx 13. [support apache shenyu metrics monitoring #507](https://github.com/apache/hertzbeat/pull/507) - Bugfix. 1. [[manager] fix cross domain problem in SecurityCorsConfiguration #469](https://github.com/apache/hertzbeat/pull/469) @zenan08 @@ -97,3 +96,4 @@ Bugfix. 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515) ---- + diff --git a/home/blog/2023-01-05-monitor-iotdb.md b/home/blog/2023-01-05-monitor-iotdb.md index b89a7441719..26dfc887aea 100644 --- a/home/blog/2023-01-05-monitor-iotdb.md +++ b/home/blog/2023-01-05-monitor-iotdb.md @@ -30,6 +30,7 @@ tags: [opensource, practice] #### 1. Enable the `metrics` function on the IoTDB side, which will provide interface data in the form of prometheus metrics. 1. The metric collection is disabled by default, you need to modify the parameters in `conf/iotdb-metric.yml` first, then restart the server + ``` # Whether to start the monitoring module, the default is false enableMetric: true @@ -73,7 +74,6 @@ For other parameters such as **collection interval**, **timeout period**, etc., - **Enable `metrics` function on IoTDB in one step** - **Another step is to configure the IP port on the HertzBeat monitoring page to add monitoring** - **In this way, we have completed the monitoring of IoTDB. We can view the monitoring details and metrics at any time to observe its service status, but people cannot always watch it. When there is always a time to rest, monitoring is often accompanied by alarms. When monitoring When the metrics are abnormal, the monitoring tool needs to be able to notify the person in charge in time** **Next, we will teach you step by step to configure the threshold alarm notification in the HertzBeat system** @@ -89,7 +89,6 @@ Path: Menu -> Alarm Threshold -> Add Threshold ![hertzbeat](/img/blog/monitor-iotdb-6.png) - 2. Add message notification recipients Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient @@ -107,7 +106,6 @@ Message notification methods support **email, DingTalk, WeChat Work, Feishu, Web ![hertzbeat](/img/blog/alert-notice-2.png) - ### Finished, now wait for the warning message to come. ding ding ding ding ``` diff --git a/home/blog/2023-01-08-monitor-shenyu.md b/home/blog/2023-01-08-monitor-shenyu.md index 6ae3e99f83c..582176e34f6 100644 --- a/home/blog/2023-01-08-monitor-shenyu.md +++ b/home/blog/2023-01-08-monitor-shenyu.md @@ -22,7 +22,6 @@ tags: [opensource, practice] - Clustering: NGINX, Docker, Kubernetes - Languages: .NET, Python, Go, Java clients available for API registration - ### HertzBeat Introduction > HertzBeat is an open source, easy to use and friendly real-time monitoring tool, no Agent, with powerful custom monitoring capabilities. @@ -44,11 +43,11 @@ tags: [opensource, practice] 1. Add the `metrics plugin` dependency to the `pom.xml` file of the gateway. ```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` 2. `metric` plugin Capture is turned off by default, edit the following in the gateway's configuration `yaml` file: @@ -118,7 +117,6 @@ Path: Menu -> Alert Thresholds -> Add Thresholds ![hertzbeat](/img/blog/monitor-shenyu-7.png) - 2. Add message notification recipients > Configure recipients to let alert message know who to send to and in what way. @@ -140,7 +138,6 @@ Message notification methods support **Email, Nail, WeChat, Flybook, WebHook, SM ![hertzbeat](/img/blog/alert-notice-2.png) - ### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding. ``` diff --git a/home/blog/2023-02-02-monitor-dynamic-tp.md b/home/blog/2023-02-02-monitor-dynamic-tp.md index 126c14044e4..cc42a8c0cab 100644 --- a/home/blog/2023-02-02-monitor-dynamic-tp.md +++ b/home/blog/2023-02-02-monitor-dynamic-tp.md @@ -17,7 +17,6 @@ tags: [opensource, practice] - Real-time monitoring of the running status of the thread pool, alarms are triggered when the alarm policy is set, and alarm information is pushed to the office platform. - Collect thread pool metrics data regularly, and use grafana as a visual monitoring platform to monitor the overall situation. - ### HertzBeat Introduction > HertzBeat is an open source, easy-to-use and friendly real-time monitoring tool with powerful customizable monitoring capabilities. @@ -130,7 +129,6 @@ Path: Menu -> Alert Thresholds -> Add Thresholds ![hertzbeat](/img/blog/monitor-dynamic-tp-6.png) - 2. Add message notification recipients > Configure recipients to let alert message know who to send to and in what way. @@ -152,7 +150,6 @@ Message notification methods support **Email, Dingtalk, WeChat, Flybook, WebHook ![hertzbeat](/img/blog/alert-notice-2.png) - ### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding. ``` diff --git a/home/blog/2023-02-10-new-committer.md b/home/blog/2023-02-10-new-committer.md index 6c4d39e259b..37bf294428f 100644 --- a/home/blog/2023-02-10-new-committer.md +++ b/home/blog/2023-02-10-new-committer.md @@ -39,11 +39,11 @@ The first PR was submitted on April 17, 2022, mainly for the problem of TDEngine So far, I have participated in the hertzbeat open source project for more than half a year, contributed a lot, and grown and gained a lot. details as follows: -* Refactored the alarm module based on the strategy mode -* Implemented metric monitoring for `Redis` database -* Optimize `spring.factories` configuration items -* Implemented message notification channels supporting `Telegram`, `Discord`, `Slack` -* Use `Thymeleaf` to restructure the alarm text, and the alarm notification template is more standardized +* Refactored the alarm module based on the strategy mode +* Implemented metric monitoring for `Redis` database +* Optimize `spring.factories` configuration items +* Implemented message notification channels supporting `Telegram`, `Discord`, `Slack` +* Use `Thymeleaf` to restructure the alarm text, and the alarm notification template is more standardized ### Thank you community friends @@ -51,8 +51,8 @@ Thanks to the friends who have helped me or inspired me for free: tomsun28, for ### Advice for newcomers -* HertzBeat's source code is very friendly to novices, with standardized code and rich comments, which is very suitable as a learning project. -* Open source contribution is not achieved overnight, every idea, every question/answer is a contribution, the first step is the most important! +* HertzBeat's source code is very friendly to novices, with standardized code and rich comments, which is very suitable as a learning project. +* Open source contribution is not achieved overnight, every idea, every question/answer is a contribution, the first step is the most important! ## Next 🌻 Armored Little Treasure @@ -68,25 +68,22 @@ github: TJxiaobao First of all, I would like to thank Brother Huacheng here, because I wanted to learn some excellent `Java` projects at that time. Then, during the meal, I asked my brother if there was any good project recommendation. At this time, my brother recommended me to Brother Tom. When I personally used `hertzbeat`, I really discovered a new continent. Compared with the simple `Java` project I was exposed to before, I was deeply impressed by the architecture design of `hertzbeat` and its practical functions. me. At this time, a seed of "wanting to contribute my own strength" has been planted in my heart. - - ### 🌻 Start submitting PR On Oct 20, 2022, I submitted `PR` for the first time. Although this `PR` is a simple translation comment, it seems that the technical content is not very high. -But he can also make me familiar with the business logic and architecture design of the project faster, and can lay a solid foundation for future contributions. +But he can also make me familiar with the business logic and architecture design of the project faster, and can lay a solid foundation for future contributions. And this `PR` is also my first step towards open source, and it is also the starting point for me to fall in love with open source! - ### 🌻 Continuous open source contribution and harvest From the first `PR` to the present, I have participated in the `hertzbeat` open source project for a while, and I have also contributed a small part, and I have grown and gained a lot. details as follows. **contribute:** -- 1. Realize the monitoring of docker containers. -- 2. Complete the domestic database DM monitoring -- 3. Write a single test for the corresponding business. -- 4. English translation of some annotations. +- 1. Realize the monitoring of docker containers. +- 2. Complete the domestic database DM monitoring +- 3. Write a single test for the corresponding business. +- 4. English translation of some annotations. **reward:** @@ -94,33 +91,30 @@ From the first `PR` to the present, I have participated in the `hertzbeat` open - 2. Broaden your horizons. - 3. Learned a lot from the bosses. - ### 🌻 Thanks to the community partners Thanks to the friends who have helped me or inspired me for free (in no particular order): tomsun28 (brother tom), Huacheng (brother) - ### 🌻 A little advice for newcomers First of all, I am also a newcomer to Novice Village, but I can share some of my experience with you, hoping to help you. -- 1. Don't be too impatient, and calm down to understand the general implementation logic of each module. -- 2. Use different functions and debug to see the underlying implementation principle of each function. -- 3. Slowly try to read the source code and understand it. -- 4. If you encounter a bug, you can directly report it to issues, or you can try to solve it yourself. - +- 1. Don't be too impatient, and calm down to understand the general implementation logic of each module. +- 2. Use different functions and debug to see the underlying implementation principle of each function. +- 3. Slowly try to read the source code and understand it. +- 4. If you encounter a bug, you can directly report it to issues, or you can try to solve it yourself. ## What is Hertz Beat? > [HertzBeat Hertz Beat](https://github.com/apache/hertzbeat) is a real-time monitoring and alarm system with powerful custom monitoring capabilities and no Agent required. Monitoring of application services, databases, operating systems, middleware, cloud native, etc., threshold alarms, and alarm notifications (email, WeChat, Dingding, Feishu, SMS, Discord, Slack, Telegram). - +> > We make protocol specifications such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure YML to use these protocols to customize and collect any metrics you want to collect. > Do you believe that you can immediately adapt to a new monitoring type such as K8s or Docker just by configuring YML? - +> > The powerful customization of `HertzBeat`, multi-type support, easy expansion, and low coupling, hope to help developers and small and medium-sized teams quickly build their own monitoring tools. **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** ## ⛄ Supported @@ -131,3 +125,4 @@ First of all, I am also a newcomer to Novice Village, but I can share some of my -Kubernetes, Docker - and more for your custom monitoring. - Notification support `Discord` `Slack` `Telegram` `Mail` `DingTalk` `WeChat` `Feishu` `SMS` `Webhook`. + diff --git a/home/blog/2023-02-11-monitor-mysql.md b/home/blog/2023-02-11-monitor-mysql.md index cdcaeb427e1..614ff205f7b 100644 --- a/home/blog/2023-02-11-monitor-mysql.md +++ b/home/blog/2023-02-11-monitor-mysql.md @@ -14,7 +14,6 @@ Keywords: [Open source monitoring tool, open source database monitoring, Mysql d > MySQL is an open source relational database management system developed by the Swedish company MySQL AB and a product of Oracle. MySQL is one of the most popular open source relational database management systems. In terms of WEB applications, MySQL is one of the best RDBMS (Relational Database Management System, relational database management system) application software. - ### Introduction to HertzBeat > HertzBeat is an open source, easy-to-use and friendly real-time monitoring tool that does not require Agent and has powerful custom monitoring capabilities. @@ -80,7 +79,6 @@ Path: Menu -> Threshold Rules -> Add Threshold ![hertzbeat](/img/blog/monitor-mysql-6.png) - 2. Add message notification recipients > Configure the receiver to let the alarm message know who to send and how to send it. @@ -89,7 +87,7 @@ Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example. -- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk to configure the robot on DingTalk and set the security custom keyword `HertzBeat `, get the corresponding `access_token` value. +- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk to configure the robot on DingTalk and set the security custom keyword `HertzBeat `, get the corresponding `access_token` value. - Configure the receiver parameters in HertzBeat as follows. 【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】 @@ -102,7 +100,6 @@ Message notification methods support **email, DingTalk, WeChat Work, Feishu, Web ![hertzbeat](/img/blog/alert-notice-2.png) - ### Finished, now wait for the warning message to come. ding ding ding ding ``` @@ -120,11 +117,11 @@ Content details: mysql db query_cache_hit_rate is too low, now is 20. :::tip This practical article took us to experience how to use the open source real-time monitoring tool HertzBeat to monitor Mysql database metric data. We can find that HertzBeat, which integrates `monitoring-alarm-notification`, is more convenient in operation and use, just click on the page The Mysql database can be included in the monitoring and alarm notification, and the tedious operations of deploying multiple components and writing configuration files are no longer needed. ::: - + Mysql Github: https://github.com/mysql/mysql-server HertzBeat Github: https://github.com/apache/hertzbeat -**Welcome to learn, use and star! ** +**Welcome to learn, use and star! ** > Only one docker command is needed to install and experience heartbeat: diff --git a/home/blog/2023-02-15-monitor-linux.md b/home/blog/2023-02-15-monitor-linux.md index 243a6608e1e..8681f564e11 100644 --- a/home/blog/2023-02-15-monitor-linux.md +++ b/home/blog/2023-02-15-monitor-linux.md @@ -81,7 +81,6 @@ Path: Menu -> Threshold Rules -> Add Threshold ![hertzbeat](/img/blog/monitor-linux-9.png) - 2. Add message notification recipients > Configure the receiver to let the alarm message know who to send and how to send it. @@ -103,7 +102,6 @@ Message notification methods support **email, DingTalk, WeChat Work, Feishu, Web ![hertzbeat](/img/blog/alert-notice-2.png) - ### Finished, now wait for the warning message to come. ding ding ding ding ``` @@ -129,10 +127,10 @@ This practical article took us to experience how to use the open source real-tim ## What is Hertz Beat? > [HertzBeat Hertz Beat](https://github.com/apache/hertzbeat) is a real-time monitoring and alarm system with powerful custom monitoring capabilities and no Agent required. Monitoring of application services, databases, operating systems, middleware, cloud native, etc., threshold alarms, and alarm notifications (email, WeChat, Dingding, Feishu, SMS, Discord, Slack, Telegram). - +> > We make protocol specifications such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure YML to use these protocols to customize and collect any metrics you want to collect. > Do you believe that you can immediately adapt to a new monitoring type such as K8s or Docker just by configuring YML? - +> > The powerful customization of `HertzBeat`, multi-type support, easy expansion, and low coupling, hope to help developers and small and medium-sized teams quickly build their own monitoring tools. **Github: https://github.com/apache/hertzbeat** @@ -147,3 +145,4 @@ This practical article took us to experience how to use the open source real-tim -Kubernetes, Docker - and more for your custom monitoring. - Notification support `Discord` `Slack` `Telegram` `Mail` `DingTalk` `WeChat` `Feishu` `SMS` `Webhook`. + diff --git a/home/blog/2023-03-15-hertzbeat-v1.3.0.md b/home/blog/2023-03-15-hertzbeat-v1.3.0.md index bc7a5631bfc..14a550ec61e 100644 --- a/home/blog/2023-03-15-hertzbeat-v1.3.0.md +++ b/home/blog/2023-03-15-hertzbeat-v1.3.0.md @@ -10,25 +10,20 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] Website: hertzbeat.com | tancloud.cn - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a9629ef5bb6e486cacddb899f1495c6e~tplv-k3u1fbpfcp-zoom-1.image) - - ### What is HertzBeat? > HertzBeat is an open source real-time monitoring and alerting tool with powerful custom monitoring capabilities and no Agent required. > It supports monitoring of application services, database, operating system, middleware, cloud native, network and other metrics, and threshold alert notification in one step. > Support more liberal threshold rules (calculation expressions), `email` `Discord` `Slack` `Telegram` `Pegging` `WeChat` `FlyBook` `SMS` `Webhook` and other ways to timely delivery. - +> > We have made the protocol specifications such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable so that you can simply configure `YML` to use these protocols to customize the collection of any metrics you want. - +> > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by defining YML? - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** @@ -42,18 +37,17 @@ After a month of iterations, HertzBeat v1.3.0 was officially released last weeke ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/b5c9dd3e28c54c72b49a7470012a0c36~tplv-k3u1fbpfcp-zoom-1.image) - **support for monitoring network switches**. -hertzbeat supported snmp protocol long time ago, windows monitoring is monitored by snmp protocol, this version we not only support more windows performance metrics, but also support snmp walk, adapt several common network switches monitoring, welcome to contribute more types and metrics to the community. + hertzbeat supported snmp protocol long time ago, windows monitoring is monitored by snmp protocol, this version we not only support more windows performance metrics, but also support snmp walk, adapt several common network switches monitoring, welcome to contribute more types and metrics to the community. - **Support for monitoring redis clusters and more database metrics**. -Community contributors have contributed extended metrics for redis clusters and multiple databases, enriching the performance metrics data. + Community contributors have contributed extended metrics for redis clusters and multiple databases, enriching the performance metrics data. - **Support iotdb1.0 storage, dependency-free mode** -and more new features welcome to explore + and more new features welcome to explore - Fix several bugs, better documentation, refactored code. ----- - +--- Only one docker command is needed to install and experience heartbeat `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` @@ -66,7 +60,7 @@ Upgrade note ⚠️. For users who previously used iotdb or tdengine to store metrics data, you need to modify application.yml to disable JPA storage `warehouse.store.jpa.enabled` as follows: -Modify `application.yml` and set `warehouse.store.jpa.enabled` parameter to false +Modify `application.yml` and set `warehouse.store.jpa.enabled` parameter to false ``` warehouse: @@ -82,7 +76,7 @@ ALTER table hzb_monitor modify job_id bigint default null; COMMIT; ``` ----- +--- ## ⛄ Supported diff --git a/home/blog/2023-03-22-monitor-springboot2.md b/home/blog/2023-03-22-monitor-springboot2.md index 2d0cbc17cfc..8dac9aade12 100644 --- a/home/blog/2023-03-22-monitor-springboot2.md +++ b/home/blog/2023-03-22-monitor-springboot2.md @@ -13,18 +13,18 @@ keywords: [opensource monitoring, SpringBoot monitoring, alert] ### HertzBeat Intro > HertzBeat is an open source, real-time monitoring tool with custom-monitor and agentLess. | 易用友好的开源实时监控告警工具，无需Agent，强大自定义监控能力. - +> > **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. > More flexible threshold rule(calculation expression), timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - +> > We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? - -> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. +> +> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. Github: https://github.com/apache/hertzbeat -### Monitoring SpringBoot2 Metrics with HertzBeat in 5 minutes +### Monitoring SpringBoot2 Metrics with HertzBeat in 5 minutes #### Prerequisite, you already have SpringBoot2 application environment and HertzBeat environment. @@ -114,13 +114,12 @@ For other parameters such as **collection interval**, **timeout period**, etc., - **Just one step to configure the IP port on the HertzBeat monitoring page and add SpringBoot2 application monitoring** - :::tip Through the above, we have completed the monitoring of the SpringBoot2 application. We can check the status and availability of various metrics of the SpringBoot2 application at any time in HertzBeat. Of course, it is impossible to manually check the metrics in real time. Monitoring is often accompanied by alarm thresholds. When the performance metrics of the SpringBoot2 application exceed our threshold or the SpringBoot2 application itself is abnormal, we can promptly notify our corresponding person in charge. The person in charge receives the notification and handles it. , this is a complete monitoring and alarm process. ::: -**Next, we will demonstrate step by step how to configure the threshold alarm notification in the HertzBeat system. When the metrics of the SpringBoot2 application are abnormal, we will be notified in time** +**Next, we will demonstrate step by step how to configure the threshold alarm notification in the HertzBeat system. When the metrics of the SpringBoot2 application are abnormal, we will be notified in time** #### 3. Add SpringBoot2 application metric threshold alarm in HertzBeat system @@ -135,7 +134,6 @@ Path: Menu -> Threshold Rules -> Add Threshold ![hertzbeat](/img/blog/monitor-springboot2-7.png) - 2. Add message notification recipients > Configure the receiver to let the alarm message know who to send and how to send it. @@ -157,7 +155,6 @@ Message notification methods support **email, DingTalk, WeChat Work, Feishu, Web ![hertzbeat](/img/blog/alert-notice-2.png) - ### Finished, now wait for the warning message to come. ding ding ding ding ``` @@ -191,11 +188,11 @@ This practical article took us to experience how to use the open source real-tim > [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring tool with custom-monitor and agentless. > **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. > More flexible threshold rule(calculation expression), timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - +> > We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? - -> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. +> +> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. ---- diff --git a/home/blog/2023-05-09-hertzbeat-v1.3.1.md b/home/blog/2023-05-09-hertzbeat-v1.3.1.md index 9ed7afbe17d..1e5c663aebd 100644 --- a/home/blog/2023-05-09-hertzbeat-v1.3.1.md +++ b/home/blog/2023-05-09-hertzbeat-v1.3.1.md @@ -10,28 +10,23 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] Website: hertzbeat.com | tancloud.cn - ![hertzBeat](/img/home/0.png) - - ### What is HertzBeat? > [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring system with custom-monitoring and agentLess. > **Monitoring+Alarm+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. > Easy to use, full web-based operation, monitoring and alerting at the click of a mouse, zero learning cost. > More flexible threshold rule, timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - +> > We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? - +> > `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. > We also provide **[Monitoring SaaS Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system in order to monitor resources. **[Get started for free](https://console.tancloud.cn)**. - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** @@ -53,13 +48,13 @@ Only one docker command is needed to install and experience hertzbeat： If use tdengine before, please upgrade tdengine to 3.0+ Please Run SQL Script When Upgrade. + ``` ALTER table hzb_alert_define modify field varchar(255) default null; COMMIT; ``` ----- - +--- ## ⛄ Supported - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -71,7 +66,7 @@ COMMIT; - and more for your custom monitoring. - Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook`. ----- +--- **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/blog/2023-05-11-greptimedb-store.md b/home/blog/2023-05-11-greptimedb-store.md index ec06dea561a..0343565c282 100644 --- a/home/blog/2023-05-11-greptimedb-store.md +++ b/home/blog/2023-05-11-greptimedb-store.md @@ -56,14 +56,13 @@ $ docker run -p 4000-4004:4000-4004 \ 2. Use ``$ docker ps | grep greptime`` to see if GreptimeDB started successfully. - #### Installing and Deploying HertzBeat See the [official documentation](https://hertzbeat.com/zh-cn/docs/start/docker-deploy) for details. 1. Docker installs HertzBeat. -```shell +```shell $ docker run -d -p 1157:1157 \ -e LANG=zh_CN.UTF-8 \ -e TZ=Asia/Shanghai \ @@ -73,8 +72,6 @@ $ docker run -d -p 1157:1157 \ --name hertzbeat apache/hertzbeat ``` - - - `-v /opt/data:/opt/hertzbeat/data` : (Optional, data persistence) Important ⚠️ Mount the H2 database files to the local host to ensure that the data will not be lost due to the creation and deletion of the container - `-v /opt/application.yml:/opt/hertzbeat/config/application.yml` : Mount customized local configuration files to the container, i.e. use local configuration files to overwrite the container configuration files. diff --git a/home/blog/2023-07-05-hertzbeat-v1.3.2.md b/home/blog/2023-07-05-hertzbeat-v1.3.2.md index ab232296099..f8eda452b26 100644 --- a/home/blog/2023-07-05-hertzbeat-v1.3.2.md +++ b/home/blog/2023-07-05-hertzbeat-v1.3.2.md @@ -10,33 +10,30 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] Website: hertzbeat.com | tancloud.cn - ![hertzBeat](/img/home/0.png) - ### What is HertzBeat? > [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring system with custom-monitoring and agentLess. > **Monitoring+Alarm+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. > Easy to use, full web-based operation, monitoring and alerting at the click of a mouse, zero learning cost. > More flexible threshold rule, timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - +> > We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? - +> > `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. > We also provide **[Monitoring SaaS Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system in order to monitor resources. **[Get started for free](https://console.tancloud.cn)**. ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** -### v1.3.2 +### v1.3.2 -Hi guys! Major release. HertzBeat v1.3.2 has published. +Hi guys! Major release. HertzBeat v1.3.2 has published. **This delightful version came out of the hard work of 27 friends. Thank them! Love 💗** @@ -52,7 +49,6 @@ In this version, we support new monitoring types and metrics for **freebsd, debi Fixed a large number of BUG, improved the document code, and improved the overall stability and usability. More new features are welcome to explore! - Let's Try Now! Only one docker command is needed to install and experience hertzbeat： @@ -68,12 +64,14 @@ Only one docker command is needed to install and experience hertzbeat： Upgrade Note⚠️. For h2 database users, sholud exec sql below: + ```sql ALTER TABLE HZB_PARAM DROP CONSTRAINT CONSTRAINT_82;; ``` How to Enable H2 WEB Console: Modify `application.yml` and restart, access `ip:1157/h2-console` + ``` spring: h2: @@ -82,10 +80,7 @@ spring: enabled: true ``` - ----- - - +--- ## ⛄ Supported - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -97,8 +92,8 @@ spring: - and more for your custom monitoring. - Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook`. ----- +--- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/blog/2023-08-14-hertzbeat-v1.4.0.md b/home/blog/2023-08-14-hertzbeat-v1.4.0.md index 142105674ca..54ea6267be8 100644 --- a/home/blog/2023-08-14-hertzbeat-v1.4.0.md +++ b/home/blog/2023-08-14-hertzbeat-v1.4.0.md @@ -22,8 +22,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] * 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` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - -> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -88,15 +87,14 @@ As for open source commercialization, the premise of open source commercializati ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_IP=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : set the collector unique identity name. - `-e MANAGER_IP=127.0.0.1` : set the main hertzbeat server ip. - `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -149,7 +147,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do * [doc] add collector clusters document by @tomsun28 in https://github.com/apache/hertzbeat/pull/1161 * [hertzbeat] release hertzbeat version v1.4.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1168 ----- +--- ## ⛄ Supported @@ -165,5 +163,5 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/blog/2023-08-28-new-committer.md b/home/blog/2023-08-28-new-committer.md index 676a572955f..222670b3c22 100644 --- a/home/blog/2023-08-28-new-committer.md +++ b/home/blog/2023-08-28-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ! [hertzBeat](/img/blog/new-committer.png) It's great to welcome a new community `Committer`, unlike other contributors `logicz` comes from an Ops implementation position at Cyberoam rather than a development position, but the quality of the contributions, both in terms of code and documentation etc. is very high 👍. This is also our `HertzBeat` and other open source projects are not the same place, because the user group is more oriented to the operation and maintenance of the development, in our 139 contributors in the operation and maintenance engineers accounted for more than 30%, which breaks the open source project collaboration and contribution to the object are the inherent cognition of the development position, which shows that whether it is the operation and maintenance engineers and test engineers to contribute to the open source project participation is very enthusiastic! This shows that both operation and maintenance engineers and test engineers are very enthusiastic about contributing to open source projects, not just as bystanders to open source collaboration. Participation in open source projects is not exclusive to a certain group of people, but is open to all who want to participate, it may be a document, a script or a piece of code, imagine your participation in the open source project is deployed to thousands of servers to run running, to help others to be used or browse the Review discussion, git record will always be kept, this may be the significance of participation in open source projects. @@ -56,9 +55,7 @@ So far, to participate in the Hertzbeat open source project has been more than f * Several document updates * * Harvesting **: - * Hertzbeat is really an excellent project, in terms of project deployment, scripts and configuration are very standardized, I write a lot of my own projects have to draw on - * The most important thing is to harvest the spirit of open source, we are in a community to communicate together, progress ## Thanks to the community partners @@ -84,7 +81,6 @@ HertzBeat HertzBeat is an open source real-time monitoring and alerting system w > `HertzBeat`'s powerful customization, multi-type support, high performance, easy to extend, low-coupling, and hopefully can help developers and teams to quickly build their own monitoring system. - Github: https://github.com/apache/hertzbeat More users are welcome to participate in `HertzBeat` open source collaboration, no matter a typo or punctuation we are very welcome. diff --git a/home/blog/2023-09-26-hertzbeat-v1.4.1.md b/home/blog/2023-09-26-hertzbeat-v1.4.1.md index cac836db123..fc91ebb300d 100644 --- a/home/blog/2023-09-26-hertzbeat-v1.4.1.md +++ b/home/blog/2023-09-26-hertzbeat-v1.4.1.md @@ -22,8 +22,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] * 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` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - -> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -45,7 +44,6 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] image - - new help moudle image @@ -73,15 +71,14 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : set the collector unique identity name. - `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. - `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -139,7 +136,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do * [hertzbeat] release hertzbeat version v1.4.1 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1261 * auto split webhook token when user input hook url by @tomsun28 in https://github.com/apache/hertzbeat/pull/1262 ----- +--- ## ⛄ Supported @@ -155,5 +152,5 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/blog/2023-11-12-hertzbeat-v1.4.2.md b/home/blog/2023-11-12-hertzbeat-v1.4.2.md index d349d02a170..ad9b6783518 100644 --- a/home/blog/2023-11-12-hertzbeat-v1.4.2.md +++ b/home/blog/2023-11-12-hertzbeat-v1.4.2.md @@ -20,8 +20,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] * 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` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - -> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -31,14 +30,12 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ### HertzBeat's 1.4.2 version release! - - support custom notice template - support push metrics monitoring(beta) - support using Huawei Cloud OBS to store monitoring templates yml - support emqx monitoring and udp port monitoring - more features , fix multiple bugs and so on - ### Install quickly via docker 1. Just one command to get started: @@ -56,15 +53,14 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : set the collector unique identity name. - `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. - `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -114,13 +110,14 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do * build hertzbeat package with jdk runtime by @tomsun28 in https://github.com/apache/hertzbeat/pull/1328 ## New Contributors + * @rbsrcy made their first contribution in https://github.com/apache/hertzbeat/pull/1268 * @XiaTian688 made their first contribution in https://github.com/apache/hertzbeat/pull/1308 * @liyin made their first contribution in https://github.com/apache/hertzbeat/pull/1311 **Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.1...v1.4.2 ----- +--- ## ⛄ Supported @@ -136,7 +133,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** ### **Download Link** @@ -159,3 +156,4 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do - ⬇️ [hertzbeat-collector-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_arm64_1.4.2.tar.gz) - ⬇️ [hertzbeat-collector-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_amd64_1.4.2.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-windows64_1.4.2.zip) + diff --git a/home/blog/2023-12-11-hertzbeat-v1.4.3.md b/home/blog/2023-12-11-hertzbeat-v1.4.3.md index 2bc4957626d..3d4508b1bff 100644 --- a/home/blog/2023-12-11-hertzbeat-v1.4.3.md +++ b/home/blog/2023-12-11-hertzbeat-v1.4.3.md @@ -21,7 +21,7 @@ keywords: [open source monitoring system, alerting system] * 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`. -> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -31,7 +31,6 @@ keywords: [open source monitoring system, alerting system] ### HertzBeat's 1.4.3 Version Release! - - enhanced reporting of external general alert API - support mysql api port website mongodb jvm redis monitoring metrics name i18n - support auto collect metrics by prometheus task @@ -43,7 +42,6 @@ keywords: [open source monitoring system, alerting system] Compatible with the Prometheus ecosystem, now we can monitor what Prometheus can monitoring with few clicks on webui. - ### Install Quickly Via Docker 1. Just one command to get started: @@ -61,15 +59,14 @@ Compatible with the Prometheus ecosystem, now we can monitor what Prometheus can ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : set the collector unique identity name. - `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. - `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -134,7 +131,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do **Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.2...v1.4.3 ----- +--- ## ⛄ Supported @@ -150,7 +147,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** ### **Download Link** @@ -173,3 +170,4 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do - ⬇️ [hertzbeat-collector-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_arm64_1.4.3.tar.gz) - ⬇️ [hertzbeat-collector-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_amd64_1.4.3.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-windows64_1.4.3.zip) + diff --git a/home/blog/2024-01-11-new-committer.md b/home/blog/2024-01-11-new-committer.md index af8533e2e37..a9828d755c5 100644 --- a/home/blog/2024-01-11-new-committer.md +++ b/home/blog/2024-01-11-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ! [hertzBeat](/img/blog/new-committer.png) > Welcome to HertzBeat's three new community committeers, let's learn more about their open source experience! @@ -39,17 +38,11 @@ In the following period, I spent some time reading Hertzbeat's code, and submitt - Exposed to a great open source community and improved my skills in related areas. - Thanks to Tom and my ospp mentor, Zheng Chenxin, who gave me a lot of help and advice during my exposure to the open source community. Currently I am still in charge of some of the code development in the community, I hope Hertzbeat can be better and better in the future! - - ----- - +--- # New Committer - SongXiao - - **Name: Zhou Shusheng** **Junior student at Henan Normal University** @@ -67,13 +60,11 @@ In July this year, after basically completing the study of Java framework develo * Support for Spring Gateway, Apache Spark, Apache Hive and other services metrics collection * Customize nginx and pop3 protocols to collect metrics for Nginx and POP3 mailbox servers, and add corresponding help files. - ## Harvest * Exposed to better and more complex large-scale projects, improved programming and problem-solving skills. * Put the theoretical knowledge into practice, gained JUC, microservice related development experience, and valuable project experience. - ## Thanks to our community partners Thanks to the author of HertzBeat, HertzBeat/Sms4j Committer Tiejia Xiaobao, Sms4j Committer Dongfeng, when I encountered problems that I could not solve, I often asked the three brothers to ask for advice, and they are always tired of patiently helping me solve the problem, there are really no words. @@ -85,14 +76,10 @@ Thanks to the other partners in the community, I've gained a lot from communicat * When you first get involved in an open source project, start with simple tasks. Gradually familiarize yourself with the code and process of the project, and gradually take on more complex tasks. * If you encounter problems that you can't solve by yourself, you can ask for help from the community. - - ----- +--- # New Committer - Dongfeng - - **Name: Zhang Yang **Freshman from Henan Normal University** @@ -126,7 +113,6 @@ Thanks to the authors of hertzbeat for the documentation and help. Thanks to my - Issues and pr's are the knock on the door of the project you are getting to know, so be willing to discuss and express your opinion. - No matter how big or small your contribution is, be willing to try and keep improving yourself. - ---- ## What is HertzBeat? @@ -142,10 +128,8 @@ Thanks to the authors of hertzbeat for the documentation and help. Thanks to my - High-performance, supports horizontal scaling of multiple collector clusters, multi-isolated network monitoring, and cloud-side collaboration. - Free alarm threshold rules, `Email` `Discord` `Slack` `Telegram` `Nail` `WeChat` `Flybook` `SMS` `Webhook` `Server sauce` and other methods of timely delivery of messages. - > ``HertzBeat``s powerful customization, multi-type support, high performance, easy to extend, low coupling, hope to help developers and teams quickly build their own monitoring system. - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/blog/2024-01-18-hertzbeat-v1.4.4.md b/home/blog/2024-01-18-hertzbeat-v1.4.4.md index e6e49efce56..66e8f6a25b3 100644 --- a/home/blog/2024-01-18-hertzbeat-v1.4.4.md +++ b/home/blog/2024-01-18-hertzbeat-v1.4.4.md @@ -21,7 +21,7 @@ keywords: [open source monitoring system, alerting system] * 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`. -> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help developers and teams quickly build their own monitoring system. ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -31,7 +31,6 @@ keywords: [open source monitoring system, alerting system] ### HertzBeat's 1.4.4 Version Release! - - support snmp v3 monitoring protocol @TJxiaobao - support monitoring NebulaGraph metrics @ZY945 - support monitoring pop3 metrics @a-little-fool @@ -44,7 +43,6 @@ keywords: [open source monitoring system, alerting system] - add smtp protocol and support smtp monitoring by @ZY945 - more feature, document and bugfix - ### Install Quickly Via Docker 1. Just one command to get started: @@ -62,15 +60,14 @@ keywords: [open source monitoring system, alerting system] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : set the collector unique identity name. - `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. - `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -83,7 +80,10 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do * monitoring the availability of websockets through handshake. by @ZY945 in https://github.com/apache/hertzbeat/pull/1413 * [Task-1386] When adding tags in tag management, random colors are given by default. by @prolevel1 in https://github.com/apache/hertzbeat/pull/1412 * add prolevel1 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1415 -* #1397 feature: support for dns monitoring by @Calvin979 in https://github.com/apache/hertzbeat/pull/1416 +* + +# 1397 feature: support for dns monitoring by @Calvin979 in https://github.com/apache/hertzbeat/pull/1416 + * Support monitoring hive metrics by @a-little-fool in https://github.com/apache/hertzbeat/pull/1417 * support legend pageable in history data charts by @tomsun28 in https://github.com/apache/hertzbeat/pull/1414 * update component tip and help tip doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1418 @@ -145,7 +145,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do **Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.3...v1.4.4 ----- +--- ## ⛄ Supported @@ -161,7 +161,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** ### **Download Link** @@ -185,7 +185,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do - ⬇️ [hertzbeat-collector-macos_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-macos_amd64_1.4.4.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-windows64_1.4.4.zip) - **hertzbeat docker compose script** -- ⬇️ [docker-compose.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) +- ⬇️ [docker-compose.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) + diff --git a/home/blog/2024-04-17-to-apache.md b/home/blog/2024-04-17-to-apache.md index 84f25fb10d1..b06725d522d 100644 --- a/home/blog/2024-04-17-to-apache.md +++ b/home/blog/2024-04-17-to-apache.md @@ -16,9 +16,6 @@ HertzBeat was officially open-sourced in January 2022 in the Dromara open-source ![](/img/blog/apache-incubator-2.png) - - - Joining the Apache Incubator is not the end, but rather a fresh start for the project. After joining the Apache Incubator, HertzBeat will actively adhere to the "openness and collaboration" philosophy of Apache at the community level, continuously building a fair, diverse, and inclusive open-source community. At the product level, we will listen to user feedback, enhance and optimize the user experience, and create connections within the open-source ecosystem. We warmly welcome everyone to join the HertzBeat community. The community accepts contributions in any form. Let's work together to promote the development of open source. Hopefully, one day, HertzBeat will become a world-class open-source product like Apache Kafka and Apache Tomcat, with our contributed code deployed and running across various industries and corners of the globe. @@ -47,7 +44,6 @@ Since its open-source release, the main repository of HertzBeat on GitHub has ac > Thank you to these lovely contributors. - @@ -278,8 +274,6 @@ Since its open-source release, the main repository of HertzBeat on GitHub has ac
- - ## Special Thanks Thank you to all contributors who have participated in the community. @@ -304,7 +298,7 @@ Special thanks to the Champions and Mentors who have kindly offered guidance to ## Message from the Dromara Community > From being a star project in the Dromara community to becoming a member of the Apache Incubator, HertzBeat has demonstrated strong vitality and healthy growth momentum. We are proud and excited about every step forward that HertzBeat has taken. Here, we extend our sincerest congratulations to the HertzBeat team and express deep gratitude to all community members who have contributed to the project. - +> > May HertzBeat continue to grow and innovate in its future journey, becoming a shining star in the open-source community. We believe that with the outstanding talent of the team and the extensive support of the community, HertzBeat will achieve even greater achievements, providing high-quality services and experiences to developers and users worldwide. Dromara will continue to fully support and pay attention to the development of HertzBeat, looking forward to it creating more wonderful chapters! --- diff --git a/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md b/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md index abde09f8a95..3e9bf0cb9c5 100644 --- a/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md +++ b/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md @@ -17,8 +17,6 @@ HertzBeat is a powerful custom monitoring capabilities, high-performance cluster **Gitee: https://gitee.com/hertzbeat/hertzbeat** - - ## What is Open Source Summer? Open Source Summer is a summer open source activity initiated and long-term supported by the "Open Source Software Supply Chain Lighting Program" of the Institute of Software of the Chinese Academy of Sciences, aiming to encourage the development of open source @@ -39,8 +37,6 @@ Open Source Summer Website: Students are free to choose the project, communicate with the community mentor to realize the plan and write the project plan. The selected students will complete the development work as planned under the guidance of community mentors and contribute the results to the community. The community evaluates the student`s completion, and the sponsor distributes the financial aid to the student based on the evaluation results. - - ## HertzBeat project ### 1、 the realization of monitoring template market store @@ -52,8 +48,6 @@ Capture the metrics we want to monitor. Some different users may have different the yml configuration may not satisfy every user, so our goal is to let users contribute their own yml template to benefit more people. This can not only make the ecology of `HertzBeat` more perfect, but also make the user experience better! - - **Requirements:** 1. Use Java17, springboot3 to write the back-end code, Angular(recommended) or Vue to write the front-end code. @@ -61,20 +55,14 @@ This can not only make the ecology of `HertzBeat` more perfect, but also make th 3. The template page displays the number of downloads, categories, template description, and (optional) template versions. 4. Realize user personal page registration, login (later), upload template. - - **Output:** 1. Feature code can be incorporated into the HertzBeat repository as PR. 2. Complete the HertzBeat official template market 3. Update the help documents - - **Contact Tutor:** Qingran Zhao [zqr10159@dromara.org](mailto:zqr10159@dromara.org) - - ### 2、 implementation of Java native ipmi2 communication protocol **Project difficulty: Advanced /Advanced** @@ -84,19 +72,14 @@ middleware monitoring without Agent. In order for HertzBeat to have a wider moni package, the implementation of the native IPMI2 protocol in the query part, and use the protocol to obtain server motherboard information, network card information, power supply information, fan information, temperature sensor information and clock information. - - **Requirements:** 1. Use Java to implement the native IPMI2 protocol (query part) based on the UDP protocol, without relying on any third-party package. 2. Use the implemented IPMI2 protocol to query indicators of the IPMI enabled server, including mainboard information, network adapter information, power supply information, and fan information -alarm, temperature sensor information and clock information. - + alarm, temperature sensor information and clock information. 3. Abstract and standardize the queried indicator information to implement configuration management (optional). 4. Output detailed project documents, including design ideas, implementation details, usage instructions, etc. - - **Output:** - Feature code can be incorporated into the HertzBeat repository as PR. @@ -107,12 +90,8 @@ alarm, temperature sensor information and clock information. - Improve help documentation. - - **Contact Tutor:** Tiejia Xiaobao [tjxiaobao2024@qq.com](mailto:tjxiaobao2024@qq.com) - - ## What can you gain by participating in HertzBeat? Some of you may wonder what can be gained by participating in Open Source Summer? @@ -123,4 +102,4 @@ Some of you may wonder what can be gained by participating in Open Source Summer 4. **【Recommended Entry/Internship】 Students with excellent performance in this Programming Summer project can be recommended to work in your preferred company.** 5. **【Additional community surprise】 All students participating in this Summer of Programming project have the opportunity to become Apache HertzBeat committer and have their own apache email.** -**There are 100% prizes to take oh**, now the only problem is that time is running out, hurry up to sign up! The deadline for registration is June 4, so hurry up and sign up for 2023 Summer of Programming. \ No newline at end of file +**There are 100% prizes to take oh**, now the only problem is that time is running out, hurry up to sign up! The deadline for registration is June 4, so hurry up and sign up for 2023 Summer of Programming. diff --git a/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md b/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md index 398b694c6bc..d421d2eaf16 100644 --- a/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md +++ b/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md @@ -24,6 +24,7 @@ Due to significant changes in `application.yml` and `sureness.yml`, it is recomm #### `application.yml` generally needs to modify the following parts: Default is: + ```yaml datasource: driver-class-name: org.h2.Driver @@ -42,7 +43,9 @@ Default is: logging: level: SEVERE ``` + If you change to a MySQL database, here is an example: + ```yaml datasource: driver-class-name: com.mysql.cj.jdbc.Driver @@ -94,49 +97,46 @@ Due to the Apache Foundation's requirements for license compliance, HertzBeat's - MySQL: [https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip) - Oracle (If you want to monitor Oracle, these two drivers are required): - - [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) - - [https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar) + - [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) + - [https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar) Next, run the start-up script as before to experience the latest HertzBeat 1.6.0! ## Docker Upgrade - Mysql Database - Stop the HertzBeat container: + ``` docker stop hertzbeat ``` - - Upgrade the database script: - - Go to [https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration), choose the directory of your database and execute the corresponding `V160__update_column.sql` file in MySQL. - + - Go to [https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration), choose the directory of your database and execute the corresponding `V160__update_column.sql` file in MySQL. - Upgrade the configuration files: - - As mentioned, due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly mount and use the new `yml` configuration files, and then modify them based on your own needs. - + - As mentioned, due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly mount and use the new `yml` configuration files, and then modify them based on your own needs. - Add the corresponding database drivers: - - Due to the Apache Foundation's license compliance requirements, HertzBeat's installation package cannot include MySQL, Oracle, and other GPL-licensed dependencies. Users need to add them themselves by downloading the driver jars from the above links and placing them in the local `ext-lib` directory, then mounting `ext-lib` to the container's `/opt/hertzbeat/ext-lib` directory when starting. + - Due to the Apache Foundation's license compliance requirements, HertzBeat's installation package cannot include MySQL, Oracle, and other GPL-licensed dependencies. Users need to add them themselves by downloading the driver jars from the above links and placing them in the local `ext-lib` directory, then mounting `ext-lib` to the container's `/opt/hertzbeat/ext-lib` directory when starting. Next, run HertzBeat using Docker as before to experience the latest HertzBeat 1.6.0! ## Docker Installation Upgrade - H2 Built-in Database (Not recommended for production use) - Stop the HertzBeat container: + ``` docker stop hertzbeat ``` - - Edit the H2 database files: - - Assuming you have mounted the H2 database files in the `data` directory to the local system, or copied the `/opt/hertzbeat/data` directory from the old container manually. - - Download the H2 driver jar from [https://mvnrepository.com/artifact/com.h2database/h2/2.2.220](https://mvnrepository.com/artifact/com.h2database/h2/2.2.220). - - Start the database locally using the H2 driver jar: - ``` - java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 - ``` + - Assuming you have mounted the H2 database files in the `data` directory to the local system, or copied the `/opt/hertzbeat/data` directory from the old container manually. + - Download the H2 driver jar from [https://mvnrepository.com/artifact/com.h2database/h2/2.2.220](https://mvnrepository.com/artifact/com.h2database/h2/2.2.220). + - Start the database locally using the H2 driver jar: + ``` + java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 + ``` - Upgrade the configuration files: - - As mentioned, due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly mount and use the new `yml` configuration files, and then modify them based on your own needs. - + - As mentioned, due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly mount and use the new `yml` configuration files, and then modify them based on your own needs. - Add the corresponding database drivers: - - As mentioned, due to the Apache Foundation's license compliance requirements, HertzBeat's installation package cannot include MySQL, Oracle, and other GPL-licensed dependencies. Users need to add them themselves by downloading the driver jars from the above links and placing them in the local `ext-lib` directory, then mounting `ext-lib` to the container's `/opt/hertzbeat/ext-lib` directory when starting. + - As mentioned, due to the Apache Foundation's license compliance requirements, HertzBeat's installation package cannot include MySQL, Oracle, and other GPL-licensed dependencies. Users need to add them themselves by downloading the driver jars from the above links and placing them in the local `ext-lib` directory, then mounting `ext-lib` to the container's `/opt/hertzbeat/ext-lib` directory when starting. Next, run the Docker to start HertzBeat as before to experience the latest HertzBeat 1.6.0! @@ -145,4 +145,5 @@ Next, run the Docker to start HertzBeat as before to experience the latest Hertz If you do not want to go through the tedious script upgrade method mentioned above, you can directly export and import the monitoring tasks and threshold information from the old environment. - Deploy a new environment with the latest version. -- Export the monitoring tasks and threshold information from the old environment on the page \ No newline at end of file +- Export the monitoring tasks and threshold information from the old environment on the page + diff --git a/home/blog/2024-06-15-hertzbeat-v1.6.0.md b/home/blog/2024-06-15-hertzbeat-v1.6.0.md index 4678774f9e4..9647d1680e3 100644 --- a/home/blog/2024-06-15-hertzbeat-v1.6.0.md +++ b/home/blog/2024-06-15-hertzbeat-v1.6.0.md @@ -15,7 +15,6 @@ In this version, we added monitoring for OpenAi, Redfish protocol servers, plugi Due to license compatibility issues, we replaced multiple dependencies at the bottom layer, Hibernate -> EclipseLink, which is also a rare migration pitfall practice in the JPA ecosystem. At the same time, some bugs were fixed and some functions were optimized, and more complete documents. Welcome everyone to try to use, put forward valuable opinions and suggestions, and promote the development of HertzBeat together. - **Of course, the most important thing is to give the best thanks to the contributors in the community!** Download Page: https://hertzbeat.apache.org/docs/download/ @@ -45,6 +44,7 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd ## HertzBeat's 1.6.0 Version Release! ## Highlights + - HertzBeat is donated to the Apache Incubator. - migrate repo, clean up code, license, add more help doc and more - add dependency license doc @@ -78,6 +78,7 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd - and more bugfix, doc, features power by our contributors, thanks to them. ## What's Changed + * bugfix collector can not startup alone by @tomsun28 in https://github.com/apache/hertzbeat/pull/1633 * translate some hertzbeat blog by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1635 * Check class description by @ZY945 in https://github.com/apache/hertzbeat/pull/1638 @@ -365,7 +366,6 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd * @lw-yang made their first contribution in https://github.com/apache/hertzbeat/pull/2047 * @xfl12345 made their first contribution in https://github.com/apache/hertzbeat/pull/2048 - ## Just one command to get started ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` @@ -374,12 +374,9 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` - Detailed refer to HertzBeat Document https://hertzbeat.com/docs - ----- - +--- **Github: https://github.com/apache/hertzbeat** Download Page: https://hertzbeat.apache.org/docs/download/ @@ -388,7 +385,7 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd Have Fun! ----- +--- HertzBeat, Make Monitoring Easier! diff --git a/home/blog/2024-07-07-new-committer.md b/home/blog/2024-07-07-new-committer.md index 46d0e8e81e6..fbb007bfed3 100644 --- a/home/blog/2024-07-07-new-committer.md +++ b/home/blog/2024-07-07-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) > 🎉 I am very pleased to become a Committer for the Apache HertzBeat project, and I have been invited by the community to introduce myself 🥰. @@ -41,6 +40,3 @@ During this process, I also incorporated some excellent experiences from other c Lastly, I want to thank the community's logicz for inviting me to become a Committer and tom for reviewing my PRs. I wish HertzBeat a successful graduation from the incubator and becoming a star project 🎊. - - - diff --git a/home/blog/2024-07-08-new-committer.md b/home/blog/2024-07-08-new-committer.md index 95afe2afcf1..b46cfec79f9 100644 --- a/home/blog/2024-07-08-new-committer.md +++ b/home/blog/2024-07-08-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) ### First acquaintance with Apache Hertzbeat @@ -49,4 +48,3 @@ This process made me understand the importance of cooperation and made me feel t Becoming a Committer of the Apache Hertzbeat project is a challenging and rewarding journey. Through continuous learning and contribution, I have not only improved my technical ability, but also found a sense of belonging and accomplishment in the community. I hope that my experience can inspire more people to participate in the open source community and jointly promote the progress and development of technology. To borrow the words of Tom: Participating in open source should not affect everyone's work and life, otherwise it will go against the original intention. Everyone should participate in the free time after get off work. - diff --git a/home/blog/2024-07-15-new-committer.md b/home/blog/2024-07-15-new-committer.md index cd8b172c609..2b8ec2bb111 100644 --- a/home/blog/2024-07-15-new-committer.md +++ b/home/blog/2024-07-15-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) Hello everyone, I am very honored to receive an invitation from the community to be nominated as a Committer for Apache HertzBeat. Let me introduce myself briefly. I have been working as a backend developer since 2019, mainly using Java. Currently, I am working at a network security company, focusing on the backend development of network security-related products. diff --git a/home/blog/2024-07-27-new-committer.md b/home/blog/2024-07-27-new-committer.md index 44128c6aabc..ed8ecc8693e 100644 --- a/home/blog/2024-07-27-new-committer.md +++ b/home/blog/2024-07-27-new-committer.md @@ -14,7 +14,7 @@ keywords: [open source monitoring system, alerting system] ## Personal introduction -I have been working as a Java back-end developer for three years. At present, I participate in the development of converged message center in an Internet company. +I have been working as a Java back-end developer for three years. At present, I participate in the development of converged message center in an Internet company. ## First met Apache Hertzbeat @@ -22,7 +22,7 @@ Reading code and design in open-source framework is one way for me to improve my ## My first PR -I failed to start Hertzbeat when I followed instructions in CONTRIBUTING. The exception shows that Node.js version at lease 18 is required. Therefor I modified CONTRIBUTING and opened my first PR in Hertzbeat community. +I failed to start Hertzbeat when I followed instructions in CONTRIBUTING. The exception shows that Node.js version at lease 18 is required. Therefor I modified CONTRIBUTING and opened my first PR in Hertzbeat community. ## Keep active in community @@ -36,4 +36,4 @@ During the reading of Hertzbeat source code, I learned a lot of code writing and ## Conclusion -It's an interesting experience for me to become a Committer of Apache Hertzbeat and it motivates me day by day. I will continue to contribute to the Apache Hertzbeat community in the future, and I hope that Apache Hertzbeat can successfully graduate from the Apache incubator. \ No newline at end of file +It's an interesting experience for me to become a Committer of Apache Hertzbeat and it motivates me day by day. I will continue to contribute to the Apache Hertzbeat community in the future, and I hope that Apache Hertzbeat can successfully graduate from the Apache incubator. diff --git a/home/blog/2024-07-28-new-committer.md b/home/blog/2024-07-28-new-committer.md index cbaeab8fb90..c04ab4716ef 100644 --- a/home/blog/2024-07-28-new-committer.md +++ b/home/blog/2024-07-28-new-committer.md @@ -11,7 +11,8 @@ keywords: [open source monitoring system, alerting system] ![hertzBeathertzBeat](/img/blog/new-committer.png) > It's an honor for me to become a Committer of Apache Hertzbeat -## Personal introduction +> + ## Personal introduction I graduated in 2023 and am currently working as a Java developer in an Internet company. @@ -30,7 +31,9 @@ I downloaded the source code of Hertzbeat and compiled and tested it according t After submitting the first PR, I continuously followed the issues in the Hertzbeat community and attempted to solve the existing problems. I have successively completed tasks such as specifying @people on WeChat, integrating AI, adding a PrestoDB monitor, modifying bugs, and contributing to the official website documentation. ## Reward + After several months of contributing to open source, I have reaped a lot. I have learned the business logic in the code, code norms, some technical frameworks that I have never used before, and some algorithms. It can be said that I have benefited greatly. ## Conclusion -Becoming a Committer of Apache Hertzbeat is a very meaningful thing for me. In the future, I will continue to contribute to the Apache Hertzbeat community. I also hope that Apache Hertzbeat can successfully graduate from the incubator and that the community will become better and better. \ No newline at end of file + +Becoming a Committer of Apache Hertzbeat is a very meaningful thing for me. In the future, I will continue to contribute to the Apache Hertzbeat community. I also hope that Apache Hertzbeat can successfully graduate from the incubator and that the community will become better and better. diff --git a/home/blog/2024-07-29-new-committer.md b/home/blog/2024-07-29-new-committer.md index 9b7e63476a5..55aecd3eb94 100644 --- a/home/blog/2024-07-29-new-committer.md +++ b/home/blog/2024-07-29-new-committer.md @@ -13,22 +13,27 @@ keywords: [open source monitoring system, alerting system] > It's an honor for me to become a Committer of Apache HertzBeat ## Becoming Part of a Stronger Team: My Contributions and Growth + In the open-source community, every contribution not only pushes the project forward but also signifies personal growth. Recently, in the Apache HertzBeat project, I have contributed through a series of optimizations and feature enhancements, which have not only advanced the project but also improved my skills. Today, I would like to share my contribution experience and insights into my growth. ## Starting from the Details: Optimizing Visuals and Interactions + I firmly believe that details determine success or failure. When I first joined the project, I began by optimizing the interface to enhance the user's visual and interactive experience. I refined the modal window layout of the monitoring selection menu to better align with user operation habits. I adjusted the header style and content layout of the monitoring details page to make information presentation clearer and more intuitive. Additionally, I unified the border-radius values of components and addressed issues such as missing internationalization translations, ensuring the consistency and completeness of the system interface. These seemingly minor changes significantly enhanced the overall aesthetics and user experience of the system. Through this process, I gained a profound understanding of the importance of interface design for user experience and honed my attention to detail. ## Delving into Functional Modules for Enhanced Capabilities + In addition to interface optimization, I actively engaged in expanding and enhancing the functional modules of the system. I refactored repetitive code within the system, abstracted common components, and improved code reusability and maintainability. These improvements not only simplified the development process but also reduced the cost of maintenance in the long run. Furthermore, I extended the capabilities of the multi-functional input component by adding support for password types and search types, further enriching its functionality and versatility. During the process of implementing these features, I encountered numerous challenges. However, these challenges spurred me to continuously learn and explore new technologies and methodologies. By consulting official documentation and other resources, I gradually overcame these obstacles and successfully completed the tasks. This process not only enhanced my technical abilities but also deepened my understanding of the importance of team collaboration. ## Emphasizing User Feedback for Continuous Product Optimization + I firmly believe that users are the ultimate judges of a product. As such, I continuously collect and analyze user feedback both within the company and in the community, using these insights to guide targeted optimizations and improvements. By refining search and filtering functionalities and adopting a consistent and concise set of interactive elements, I have consistently enhanced the user experience. In this process, I realized the importance of a user-centric approach. Only by genuinely focusing on users' needs and expectations can we create products that meet market demands. ## Looking Ahead: Continuous Contribution and Growth + Reflecting on my past contributions, I feel a profound sense of pride and satisfaction. However, I am also acutely aware of the many areas where I still have room for improvement and need to continue learning and growing. Moving forward, I will uphold the spirit of rigor, innovation, and user-centricity, continuously exploring and practicing to contribute even more to the Apache HertzBeat project. I eagerly anticipate the opportunity to grow and progress alongside my fellow team members, jointly driving the project towards prosperity and success. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md index 255046201cc..02e2cbdd0c8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md @@ -4,16 +4,16 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- -[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 +[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 -**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** +**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** -从v1.0-beta.1到v1.0-beat.8，经过多个版本的迭代完善，我们很高兴宣布hertzbeat v1.0正式发布。 +从v1.0-beta.1到v1.0-beat.8，经过多个版本的迭代完善，我们很高兴宣布hertzbeat v1.0正式发布。 -感谢从beat.1版本以来 HertzBeat Contributors 的贡献，社区同学和用户们的支持。 此版本更新支持了Redis的监控( @gcdd1993 贡献)，覆盖Redis的内存CPU等各个性能指标，全方面监控Redis。修复了多个bug进一步增强稳定性。 +感谢从beat.1版本以来 HertzBeat Contributors 的贡献，社区同学和用户们的支持。 此版本更新支持了Redis的监控( @gcdd1993 贡献)，覆盖Redis的内存CPU等各个性能指标，全方面监控Redis。修复了多个bug进一步增强稳定性。 @@ -64,7 +64,6 @@ Redis监控来啦： 2022-05-29 20 24 21 - > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn)开源的一个支持网站，API，PING，端口，数据库，操作系统等监控类型，拥有易用友好的可视化操作界面的开源监控告警项目。 > 当然，我们也提供了对应的[SAAS云监控版本](https://console.tancloud.cn)，中小团队和个人无需再为了监控自己的网站资源，而去部署一套繁琐的监控系统，[登录即可免费开始](https://console.tancloud.cn)监控之旅。 > HertzBeat 支持自定义监控，只用通过配置YML文件我们就可以自定义需要的监控类型和指标，来满足常见的个性化需求。 @@ -72,10 +71,9 @@ Redis监控来啦： > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 > 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 - +> > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 - **仓库地址** [Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md index 82c59c3b8ec..15d260bd215 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md @@ -4,12 +4,12 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- -[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 +[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 -**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** +**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** 大家好，HertzBeat v1.1.0 发布啦！这个版本我们支持了SNMP协议，并使用SNMP协议监控支持了windwos操作系统的应用监控。 另一个重大变更是我们默认使用了H2数据库来替换MYSQL数据库作为存储，来方便使用者们的安装部署，现在只需要一条docker命令即可安装体验hertzbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` @@ -35,12 +35,11 @@ Bugfix. Online https://console.tancloud.cn. ------------------------ +--- Windows Monitor coming： 2022-06-19 11 30 57 - ⚠️ ⚠️⚠️⚠️请注意其它版本升级到v1.1.0需要先执行下面的SQL脚本. 现在我们的表名称有个统一前缀 hzb_ prefix. ``` @@ -55,13 +54,14 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` +``` Have Fun! ---- ## V1.1.0 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. @@ -76,7 +76,7 @@ Feature： 2. [[monitor]change default database mysql to h2 #191](https://github.com/apache/hertzbeat/pull/191) 3. [[manager]support monitor params name i18n #184](https://github.com/apache/hertzbeat/pull/184). 4. [[script]build multi cpu arch hertzbeat docker version #189](https://github.com/apache/hertzbeat/pull/189). -5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time +5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time 6. [[monitor]database tables append prefix hzb_ #193](https://github.com/apache/hertzbeat/pull/193) issue from @shimingxy Bugfix. @@ -88,12 +88,12 @@ Bugfix. Online https://console.tancloud.cn. ------------------------ +--- + Windows Monitor coming： 2022-06-19 11 30 57 - ⚠️ ⚠️⚠️⚠️Attention other version upgrade to v1.1.0 need run sql script. Now the tables name has hzb_ prefix. ``` @@ -108,10 +108,9 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` - -Have Fun! +``` +Have Fun! ---- @@ -122,11 +121,9 @@ Have Fun! > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 > 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 - +> > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 - - **仓库地址** [Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md index a949092e375..15d260bd215 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md @@ -4,12 +4,12 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- -[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 +[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 -**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** +**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** 大家好，HertzBeat v1.1.0 发布啦！这个版本我们支持了SNMP协议，并使用SNMP协议监控支持了windwos操作系统的应用监控。 另一个重大变更是我们默认使用了H2数据库来替换MYSQL数据库作为存储，来方便使用者们的安装部署，现在只需要一条docker命令即可安装体验hertzbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` @@ -35,12 +35,11 @@ Bugfix. Online https://console.tancloud.cn. ------------------------ +--- Windows Monitor coming： 2022-06-19 11 30 57 - ⚠️ ⚠️⚠️⚠️请注意其它版本升级到v1.1.0需要先执行下面的SQL脚本. 现在我们的表名称有个统一前缀 hzb_ prefix. ``` @@ -55,13 +54,14 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` +``` Have Fun! ---- ## V1.1.0 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. @@ -76,7 +76,7 @@ Feature： 2. [[monitor]change default database mysql to h2 #191](https://github.com/apache/hertzbeat/pull/191) 3. [[manager]support monitor params name i18n #184](https://github.com/apache/hertzbeat/pull/184). 4. [[script]build multi cpu arch hertzbeat docker version #189](https://github.com/apache/hertzbeat/pull/189). -5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time +5. [[monitor]feature: support oracle multi tablespaces #163](https://github.com/apache/hertzbeat/pull/163) contribute by @brave4Time 6. [[monitor]database tables append prefix hzb_ #193](https://github.com/apache/hertzbeat/pull/193) issue from @shimingxy Bugfix. @@ -88,12 +88,12 @@ Bugfix. Online https://console.tancloud.cn. ------------------------ +--- + Windows Monitor coming： 2022-06-19 11 30 57 - ⚠️ ⚠️⚠️⚠️Attention other version upgrade to v1.1.0 need run sql script. Now the tables name has hzb_ prefix. ``` @@ -108,10 +108,9 @@ ALTER TABLE param_define RENAME TO hzb_param_define; ALTER TABLE tag RENAME TO hzb_tag; ALTER TABLE tag_monitor_bind RENAME TO hzb_tag_monitor_bind; commit; -``` - -Have Fun! +``` +Have Fun! ---- @@ -122,10 +121,9 @@ Have Fun! > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 > 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 - +> > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 - **仓库地址** [Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md index b3de59cfbb2..589b8113d31 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md @@ -4,12 +4,12 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- -[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 +[HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn) 开源的一个支持网站，API，PING，端口，数据库，全站，操作系统，中间件等监控类型，支持阈值告警，告警通知 (邮箱，webhook，钉钉，企业微信，飞书机器人)，拥有易用友好的可视化操作界面的开源监控告警项目。 -**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** +**官网: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** 大家好，HertzBeat v1.1.1 发布啦！这个版本带来了自定义监控增强，采集指标数据可以作为变量赋值给下一个采集。修复了若干bug，提升整体稳定性。 @@ -24,7 +24,7 @@ Feature： 2. [[monitor] 支持前置采集指标数据作为变量赋值给下一采集流程 #206](https://github.com/apache/hertzbeat/pull/206). 3. [[collector] 使用基本的http headers头实现basic auth替换前置模式 #212](https://github.com/apache/hertzbeat/pull/212) 4. [[manager,alerter] 支持告警通知设置钉钉机器人微信飞书自定义 webhook url #213](https://github.com/apache/hertzbeat/pull/213) -5. [[monitor] feature 更新数值指标数据不带末尾为0的小数点 #217](https://github.com/apache/hertzbeat/pull/217) +5. [[monitor] feature 更新数值指标数据不带末尾为0的小数点 #217](https://github.com/apache/hertzbeat/pull/217) 6. [[web-app]feature:toggle [enable and cancel] button #218](https://github.com/apache/hertzbeat/pull/218) 7. [[manager] 更新监控define yml文件前缀名称 "app" or "param"，便于自定义监控区别 #221](https://github.com/apache/hertzbeat/pull/221) @@ -42,7 +42,6 @@ Bugfix. Online https://console.tancloud.cn. - Have Fun! ---- @@ -54,10 +53,9 @@ Have Fun! > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 > 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 - +> > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 - **仓库地址** [Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-04-hertzbeat-v1.1.3.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-04-hertzbeat-v1.1.3.md index affc90b5c34..e4c3064b1fd 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 @@ -4,7 +4,7 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource] +tags: [opensource] --- Home: hertzbeat.com | tancloud.cn @@ -22,9 +22,9 @@ Feature： 2. [[monitor] feature: support apache kafka monitor #263](https://github.com/apache/hertzbeat/pull/263) contribute by @wang1027-wqh 3. [[webapp] support history chart query 3 mouth time range #265](https://github.com/apache/hertzbeat/pull/265) issue by @ericfrol 4. [[monitor] support ssl certificate expired monitor #266](https://github.com/apache/hertzbeat/pull/266) suggest by @noear -5. [[web-app] update default interval 600s to 120s #268](https://github.com/apache/hertzbeat/pull/268) -6. [[web-app] update layout ui - help button, nav menu #272](https://github.com/apache/hertzbeat/pull/272) -7. [[alert,webapp] support delete all alerts at once. #273](https://github.com/apache/hertzbeat/pull/273) issue by @ericfrol +5. [[web-app] update default interval 600s to 120s #268](https://github.com/apache/hertzbeat/pull/268) +6. [[web-app] update layout ui - help button, nav menu #272](https://github.com/apache/hertzbeat/pull/272) +7. [[alert,webapp] support delete all alerts at once. #273](https://github.com/apache/hertzbeat/pull/273) issue by @ericfrol 8. [[web-app] update home background image #276](https://github.com/apache/hertzbeat/pull/276) Bugfix. @@ -37,9 +37,9 @@ Bugfix. Online https://console.tancloud.cn. Have Fun! ----- - +--- ## V1.1.3 + 官网: hertzbeat.com | tancloud.cn 大家好，HertzBeat v1.1.3 发布啦！这个版本支持了apache kafka监控，SSL证书过期监控等。修复了若干bug，提升整体稳定性。 @@ -55,9 +55,9 @@ Feature： 2. [[monitor] feature: support apache kafka monitor #263](https://github.com/apache/hertzbeat/pull/263) contribute by @wang1027-wqh 3. [[webapp] support history chart query 3 mouth time range #265](https://github.com/apache/hertzbeat/pull/265) issue by @ericfrol 4. [[monitor] support ssl certificate expired monitor #266](https://github.com/apache/hertzbeat/pull/266) suggest by @noear -5. [[web-app] update default interval 600s to 120s #268](https://github.com/apache/hertzbeat/pull/268) -6. [[web-app] update layout ui - help button, nav menu #272](https://github.com/apache/hertzbeat/pull/272) -7. [[alert,webapp] support delete all alerts at once. #273](https://github.com/apache/hertzbeat/pull/273) issue by @ericfrol +5. [[web-app] update default interval 600s to 120s #268](https://github.com/apache/hertzbeat/pull/268) +6. [[web-app] update layout ui - help button, nav menu #272](https://github.com/apache/hertzbeat/pull/272) +7. [[alert,webapp] support delete all alerts at once. #273](https://github.com/apache/hertzbeat/pull/273) issue by @ericfrol 8. [[web-app] update home background image #276](https://github.com/apache/hertzbeat/pull/276) Bugfix. @@ -69,6 +69,6 @@ Bugfix. Online https://console.tancloud.cn. - Have Fun! ----- +--- + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md index d7f06703c97..75bf7f7008c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md @@ -4,7 +4,7 @@ author: tom author_title: tom author_url: https://github.com/tomsun28 author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 -tags: [opensource, practice] +tags: [opensource, practice] --- 先祝看到的同学中秋快乐，身体健康，在身体健康的基础上尽量暴富。 @@ -38,7 +38,6 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd53f343a5b54feab62e71458d076441~tplv-k3u1fbpfcp-zoom-1.image) 2. 配置监控网站 @@ -52,52 +51,38 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > 在监控列表可以查看任务状态，进监控详情可以查看指标数据图表等。 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f874b45e909c4bb0acdd28b3fb034a61~tplv-k3u1fbpfcp-zoom-1.image) - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ef5d7443f8c04818ae5aa28d421203be~tplv-k3u1fbpfcp-zoom-1.image) - - 4. 设置阈值(证书过期时触发) > 系统页面 -> 告警 -> 告警阈值 -> 新增阈值 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d6205172d43463aa34e534477f132f1~tplv-k3u1fbpfcp-zoom-1.image) > 配置阈值，选择SSL证书指标对象，配置告警表达式-当指标`expired`为`true`触发，即`equals(expired,"true")` , 设置告警级别通知模版信息等。 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/83d17b381d994f26a6240e01915b2001~tplv-k3u1fbpfcp-zoom-1.image) > 关联阈值与监控, 在阈值列表设置此阈值应用于哪些监控。 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9b9063d7bcf9454387be0491fc382bd1~tplv-k3u1fbpfcp-zoom-1.image) - - - 5. 设置阈值(证书过期前一周触发) > 同理如上，新增配置阈值，配置告警表达式-当指标有效期时间戳 `end_timestamp`，`now()`函数为当前时间戳，若配置提前一周触发告警即：`end_timestamp <= (now() + 604800000)` , 其中 `604800000` 为7天总时间差毫秒值。 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0d6f837f57c247e09f668f60eff4a0ff~tplv-k3u1fbpfcp-zoom-1.image) > 最终可以在告警中心看到已触发的告警。 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5a61b23127524976b2c209ce0ca6a339~tplv-k3u1fbpfcp-zoom-1.image) - 6. 告警通知(通过钉钉微信飞书等及时通知) > 监控系统 -> 告警通知 -> 新增接收人 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7f36956060ef410a82bbecafcbb2957f~tplv-k3u1fbpfcp-zoom-1.image) 钉钉微信飞书等token配置可以参考帮助文档 @@ -107,7 +92,6 @@ https://tancloud.cn/docs/help/alert_dingtalk > 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d976343e81f843138344a039f3aff8a3~tplv-k3u1fbpfcp-zoom-1.image) 7. OK 当阈值触发后我们就可以收到对应告警消息啦，如果没有配通知，也可以在告警中心查看告警信息。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md index 38541e27286..4daa13c04e2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md @@ -26,9 +26,9 @@ Feature： 2. [[webapp] auto redirect url when detect browser language #289](https://github.com/apache/hertzbeat/pull/289) contribute by @DreamGirl524 3. [[home] update logo icon cdn url with fault tolerance #293](https://github.com/apache/hertzbeat/pull/293) contribute by @VampireAchao 4. [[monitor] enable powerful jsonpath parser, add es metrics #295](https://github.com/apache/hertzbeat/pull/295) contribute by @Ceilzcx -5. [[webapp] update ui theme #296](https://github.com/apache/hertzbeat/pull/296) -6. [Feature change main pom artifactId #300](https://github.com/apache/hertzbeat/pull/300) contribute by @Privauto -7. [[home,webapp] add users logo and update hertzbeat brand #302](https://github.com/apache/hertzbeat/pull/302) +5. [[webapp] update ui theme #296](https://github.com/apache/hertzbeat/pull/296) +6. [Feature change main pom artifactId #300](https://github.com/apache/hertzbeat/pull/300) contribute by @Privauto +7. [[home,webapp] add users logo and update hertzbeat brand #302](https://github.com/apache/hertzbeat/pull/302) 8. [[monitor] alerter notify test throw msg to front, optional spring.email config #305](https://github.com/apache/hertzbeat/pull/305) contribute by @Ceilzcx 9. [[home]doc:update docker-deploy.md and tdengine-init.md #306](https://github.com/apache/hertzbeat/pull/306) contribute by @Privauto 10. [[hertzbeat] refactor common collect metrics data and alert data queue #320](https://github.com/apache/hertzbeat/pull/320) @@ -58,14 +58,17 @@ Have Fun! ### Upgrade⚠️ Need Convert `application.yml` + ``` spring: resources: static-locations: - classpath:/dist/ - classpath:../dist/ -``` +``` + To + ``` spring: web: @@ -78,6 +81,7 @@ spring: ---- ## V1.2.0 + 官网: hertzbeat.com | tancloud.cn 大家好，HertzBeat v1.2.0 发布啦！这个版本支持了更强大的jsonpath去采集自定义监控指标，将springboot版本升级到2.7，支持指标单位的提取转换展示等。修复了若干bug，提升整体稳定性。 @@ -95,9 +99,9 @@ Feature： 2. [[webapp] auto redirect url when detect browser language #289](https://github.com/apache/hertzbeat/pull/289) contribute by @DreamGirl524 3. [[home] update logo icon cdn url with fault tolerance #293](https://github.com/apache/hertzbeat/pull/293) contribute by @VampireAchao 4. [[monitor] enable powerful jsonpath parser, add es metrics #295](https://github.com/apache/hertzbeat/pull/295) contribute by @Ceilzcx -5. [[webapp] update ui theme #296](https://github.com/apache/hertzbeat/pull/296) -6. [Feature change main pom artifactId #300](https://github.com/apache/hertzbeat/pull/300) contribute by @Privauto -7. [[home,webapp] add users logo and update hertzbeat brand #302](https://github.com/apache/hertzbeat/pull/302) +5. [[webapp] update ui theme #296](https://github.com/apache/hertzbeat/pull/296) +6. [Feature change main pom artifactId #300](https://github.com/apache/hertzbeat/pull/300) contribute by @Privauto +7. [[home,webapp] add users logo and update hertzbeat brand #302](https://github.com/apache/hertzbeat/pull/302) 8. [[monitor] alerter notify test throw msg to front, optional spring.email config #305](https://github.com/apache/hertzbeat/pull/305) contribute by @Ceilzcx 9. [[home]doc:update docker-deploy.md and tdengine-init.md #306](https://github.com/apache/hertzbeat/pull/306) contribute by @Privauto 10. [[hertzbeat] refactor common collect metrics data and alert data queue #320](https://github.com/apache/hertzbeat/pull/320) @@ -121,23 +125,24 @@ Bugfix. 9. [[web-app] fix echarts y-axis value tip overflow #325](https://github.com/apache/hertzbeat/pull/325) 10. [[webapp] fix interceptor http resp common error-msg when error #329](https://github.com/apache/hertzbeat/pull/329) - Online https://console.tancloud.cn. - Have Fun! ### 升级注意⚠️ 需要将配置文件内容 `application.yml` + ``` spring: resources: static-locations: - classpath:/dist/ - classpath:../dist/ -``` +``` + 变更为 + ``` spring: web: @@ -148,3 +153,4 @@ spring: ``` ---- + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md index f8488941bd4..941192b69cc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md @@ -8,6 +8,7 @@ tags: [opensource] --- ## v1.2.2 + Home: hertzbeat.com | tancloud.cn Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernets, docker, springboot, nacos and database dm, opengauss and more. Also we bring a experimental feature, users can custom define metrics collect from promethues with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage mertics. @@ -26,8 +27,8 @@ Feature： 2. [[home] add DM db document supplement #411](https://github.com/apache/hertzbeat/pull/411) @TJxiaobao 3. [[home] support algolia search #416](https://github.com/apache/hertzbeat/pull/416) 4. [[collector] support trigger and grading multiple subtasks through -_- placeholder expression #418](https://github.com/apache/hertzbeat/pull/418) -5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu -6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422) +5. [WIP:feature support k8s monitor, http monitor nacos, service&http_micro monitor msa #421](https://github.com/apache/hertzbeat/pull/421) @cuipiheqiuqiu +6. [[manager] support opengauss database monitor #422](https://github.com/apache/hertzbeat/pull/422) 7. [[#406][warehose] Add unit test MetricsDataControllerTest.java #426](https://github.com/apache/hertzbeat/pull/426) @haibo-duan 8. [[#358][manager] Add unit test manager/service/NoticeConfigServiceTest.java #427](https://github.com/apache/hertzbeat/pull/427) @haibo-duan 9. [[#356][manager] unit test case of manager/service/MailServiceTest.java #432](https://github.com/apache/hertzbeat/pull/432) @csyshu @@ -40,7 +41,6 @@ Feature： 16. [[hertzbeat] update use PromQL to collect metrics from promethues server #456](https://github.com/apache/hertzbeat/pull/456) 17. [[manager] support custom monitor api response data code #460](https://github.com/apache/hertzbeat/pull/460) - Bugfix. 1. [【bugfix#408】if logs dir not exist, create logs dir #409](https://github.com/apache/hertzbeat/pull/409) @Ceilzcx @@ -58,6 +58,7 @@ Have Fun! ---- ## V1.2.2 + 官网: hertzbeat.com | tancloud.cn 大家好，HertzBeat v1.2.2发布啦！这个版本带来个超多重大更新，我们支持了对云原生kubernets, docker的监控，支持了对springboot应用, nacos注册发现中心，达梦数据库，opengauss数据库等的指标监控。我们也引入了一个实验性特性，用户可以使用promethues promql 从promethues server拿取指标数据作为hertzbeat自定义监控指标数据。当然我们也新增了多个测试用户覆盖，修复了多个BUG。还有个很多用户想要的更新，我们新增了对linux监控的top10 cpu 内存利用率的进程监控指标。有个这个指标，我们就可以干很多事情。比如监控某个进程CPU异常，内存爆满啥的。快来试试吧！ @@ -89,7 +90,6 @@ Feature： 16. [[hertzbeat] update use PromQL to collect metrics from promethues server #456](https://github.com/apache/hertzbeat/pull/456) 17. [[manager] support custom monitor api response data code #460](https://github.com/apache/hertzbeat/pull/460) - Bugfix. 1. [【bugfix#408】if logs dir not exist, create logs dir #409](https://github.com/apache/hertzbeat/pull/409) @Ceilzcx @@ -101,3 +101,4 @@ Bugfix. 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear ---- + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md index 04a7e28d849..34df92ffbd4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md @@ -9,7 +9,6 @@ tags: [opensource] > 非常高兴 HertzBeat 迎来了两位新晋社区Committer, 两位都是来自互联网公司的开发工程师，让我们来了解下他们的开源经历吧！ - ## 第一位 花城 姓名：王庆华 @@ -25,18 +24,18 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh) 说起来挺偶然的，结识hertzbeat是因为我大学的毕业设计，当时在一家互联网公司实习，那个时候第一次看到了企业是怎么监控项目的，不管是系统监控、业务监控还是物联网iot监控，那个时候见世面不广，只知道Prometheus + Grafana，但是学起来、用起来成本比较高，那个时候就觉得应该有其他类型的监控，恰好，到了大学毕业设计选题，我就开始寻找这方面的开源项目，那个时候我们小组正在使用Shen Yu网关，我就看了下社区，发现了hertzbeat，自此我便于它结缘了。 ## 开始提交PR + 到了2022-02-18 我开始提交了我第一个pr，当时只是为了优化一些controller入参的格式，没有什么技术含量，但是这是我接触开源的第一步，让我在从理论学习跨出了实践的一步 ## 持续的开源贡献与收获 到目前为止，参与hertzbeat开源项目已有半年多时间，贡献了许多，也成长收获了许多。具体如下： -1. 见证了hertzbeat的贡献值从0到1 -2. 兼容了zookeeper、JVM、Kafka等监控功能 -3. 实现了hertzbeat项目的国际化 -4. 参与了开源之夏并顺利结项 -5. 增加了监控系统的基础告警功能: 钉钉、飞书、企业微信、邮箱等 - +1. 见证了hertzbeat的贡献值从0到1 +2. 兼容了zookeeper、JVM、Kafka等监控功能 +3. 实现了hertzbeat项目的国际化 +4. 参与了开源之夏并顺利结项 +5. 增加了监控系统的基础告警功能: 钉钉、飞书、企业微信、邮箱等 ## 感谢社区小伙伴 @@ -44,14 +43,13 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh) ## 对新人的一点建议 -1. 不要觉得自己一上手就能接触到核心，心急吃不了热豆腐 -2. 不要只注重看代码，要上手搭建、使用 -3. 有想法就大胆尝试，不管自己的方案是否完善 -4. 多多关注开源，了解社区动态，多和开源开发者交流 - +1. 不要觉得自己一上手就能接触到核心，心急吃不了热豆腐 +2. 不要只注重看代码，要上手搭建、使用 +3. 有想法就大胆尝试，不管自己的方案是否完善 +4. 多多关注开源，了解社区动态，多和开源开发者交流 ------ ------ +--- +--- ## 第二位 星辰 @@ -65,13 +63,10 @@ Hertzbeat Committer github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) - ## 初识Hertzbeat 2022年8月开始接触Hertzbeat，由于公司监控elasticsearch使用的cerebro，虽然有非常强大的数据监控，但缺少告警通知的功能；就去github上浏览监控类的项目，刚好看到Hertzbeat，对此非常感兴趣，在了解完整个项目结构和实现后，刚好elasticsearch的监控部分做的不够完善，我就根据cerebro完善了这部分监控数据并提交了pull request。后面在tom老哥的帮助下也开始其他部分的实现。 - - ## 开始提交PR 从2022年9月至今提交了好几个pr，主要包括： @@ -83,8 +78,6 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) + 一些bug的修复。。。 + promethues exporter 协议解析 - - ## 持续的开源贡献与收获 到目前为止，参与Hertzbeat社区开源已有半年多时间，贡献了许多，也成长收获了许多。 @@ -93,19 +86,16 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) 同时在社区群里，看到别人提的问题和帮助别人可以学到很多新的知识，很多问题你目前不一定会遇到，其他人遇到的时候你可以思考并收获很多知识。 - ## 感谢社区小伙伴 感谢无偿帮助过我或给过我启发的小伙伴：[tomsun28](https://github.com/tomsun28) - ## 对新人的一点建议 + 使用者可以先看官网，官网基本能够解决你的问题。部分简单或者常见的问题其他可以自己解决，对自己也是一种锻炼 + 可以尝试阅读源码，大部分源码都是包含注释的，并不难；不懂的地方也可以通过运行test，debug看一下整个流程 + 有想法或者bug，可以前往gitee或者github提交issues，也可以在群里询问，不要怕，都是从菜逼过来的 - ## 如何参与Hertzbeat + 官网有非常完善的贡献者指南：[贡献者指南 | HertzBeat](https://hertzbeat.com/docs/community/contribution) @@ -114,5 +104,5 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) + 如果是大的改动，建议提交前编写issues，在提交pr，同时请注意编码的规范，尽量减少bug和警告的产生 - > 以上就是我们新晋Committer们的开源经历了，可以看出参与开源并不难，更重要的是迈出第一步，无论是代码还是文档修复或者提交issue，这些都是贡献者参与开源的姿势。快来加入我们吧！ + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md index 79028a22e82..5bc276eb240 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md @@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource] --- -## v1.2.3 +## v1.2.3 Home: hertzbeat.com | tancloud.cn @@ -38,7 +38,6 @@ Feature： 12. [add Prometheus exporter metrics parser and IoTDB monitor #505](https://github.com/apache/hertzbeat/pull/505) @Ceilzcx 13. [support apache shenyu metrics monitoring #507](https://github.com/apache/hertzbeat/pull/507) - Bugfix. 1. [[manager] fix cross domain problem in SecurityCorsConfiguration #469](https://github.com/apache/hertzbeat/pull/469) @zenan08 @@ -57,6 +56,7 @@ Have Fun! ---- ## V1.2.3 + 官网: hertzbeat.com | tancloud.cn 大家好，HertzBeat v1.2.3发布啦！这个版本带来了重大更新，我们支持了对prometheus exporter协议监控，用户可以很方便的使用hertzbeat来适配监控prometheus exporter. 基于这个能力，这个版本我们也支持了对apache shenyu, apache iotdb的指标监控。我们更新了UI布局，修复了多个BUG，也支持了短信通知。快来体验下吧! @@ -84,7 +84,6 @@ Feature： 12. [add Prometheus exporter metrics parser and IoTDB monitor #505](https://github.com/apache/hertzbeat/pull/505) @Ceilzcx 13. [support apache shenyu metrics monitoring #507](https://github.com/apache/hertzbeat/pull/507) - Bugfix. 1. [[manager] fix cross domain problem in SecurityCorsConfiguration #469](https://github.com/apache/hertzbeat/pull/469) @zenan08 @@ -97,3 +96,4 @@ Bugfix. 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515) ---- + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md index 95283ff6ada..74b9d28d2f6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md @@ -10,12 +10,12 @@ keywords: [开源监控系统, 开源数据库监控, IotDB数据库监控] ## 使用 HertzBeat 对物联网数据库 IoTDB 进行监控实践，5分钟搞定！ -### IoTDB 介绍 +### IoTDB 介绍 > Apache IoTDB (Internet of Things Database) 是一款时序数据库管理系统，可以为用户提供数据收集、存储和分析等服务。 -> IoTDB由于其轻量级架构、高性能和高可用的特性，以及与 Hadoop 和 Spark 生态的无缝集成，满足了工业 IoT 领域中海量数据存储、高吞吐量数据写入和复杂数据查询分析的需求。 +> IoTDB由于其轻量级架构、高性能和高可用的特性，以及与 Hadoop 和 Spark 生态的无缝集成，满足了工业 IoT 领域中海量数据存储、高吞吐量数据写入和复杂数据查询分析的需求。 -### HertzBeat 介绍 +### HertzBeat 介绍 > HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 > 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书)。 @@ -23,14 +23,15 @@ keywords: [开源监控系统, 开源数据库监控, IotDB数据库监控] ### 在 HertzBeat 5分钟搞定监控 IoTDB -#### 操作前提，您已拥有 IoTDB 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 IoTDB 环境和 HertzBeat 环境。 -- IoTDB [部署安装文档](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/QuickStart.html) -- HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) +- IoTDB [部署安装文档](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/QuickStart.html) +- HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) #### 一. 在 IoTDB 端开启`metrics`功能，它将提供 prometheus metrics 形式的接口数据。 -1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server +1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server + ``` # 是否启动监控模块，默认为false enableMetric: true @@ -41,75 +42,72 @@ metricReporterList: - PROMETHEUS ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 -#### 二. 在 HertzBeat 监控页面添加 IoTDB 监控 +#### 二. 在 HertzBeat 监控页面添加 IoTDB 监控 -1. 点击新增IoTDB监控 +1. 点击新增IoTDB监控 -路径：菜单 -> 数据库监控 -> IoTDB监控 -> 新增IoTDB监控 +路径：菜单 -> 数据库监控 -> IoTDB监控 -> 新增IoTDB监控 -![hertzbeat](/img/blog/monitor-iotdb-1.png) +![hertzbeat](/img/blog/monitor-iotdb-1.png) -2. 配置监控IoTDB所需参数 +2. 配置监控IoTDB所需参数 在监控页面填写 IoTDB **服务IP**，**监控端口**(默认9091)，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/iotdb/) https://hertzbeat.com/docs/help/iotdb/ +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/iotdb/) https://hertzbeat.com/docs/help/iotdb/ -![hertzbeat](/img/blog/monitor-iotdb-2.png) +![hertzbeat](/img/blog/monitor-iotdb-2.png) -3. 完成✅,现在我们已经添加好对 IoTDB 的监控了，查看监控列表即可看到我们的添加项。 +3. 完成✅,现在我们已经添加好对 IoTDB 的监控了，查看监控列表即可看到我们的添加项。 -![hertzbeat](/img/blog/monitor-iotdb-3.png) +![hertzbeat](/img/blog/monitor-iotdb-3.png) -4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 IoTDB的实时监控指标数据。 +4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 IoTDB的实时监控指标数据。 -![hertzbeat](/img/blog/monitor-iotdb-4.png) +![hertzbeat](/img/blog/monitor-iotdb-4.png) -5. 点击**监控历史详情TAB** 即可浏览 IoTDB的历史监控指标数据图表📈。 +5. 点击**监控历史详情TAB** 即可浏览 IoTDB的历史监控指标数据图表📈。 -![hertzbeat](/img/blog/monitor-iotdb-5.png) +![hertzbeat](/img/blog/monitor-iotdb-5.png) **完成DONE！通过上面几步，总结起来其实也就是两步** - **一步开启 IoTDB 端`metrics`功能** -- **另一步在 HertzBeat 监控页面配置IP端口添加监控即可** - +- **另一步在 HertzBeat 监控页面配置IP端口添加监控即可** -**这样我们就完成了对 IoTDB 的监控，我们可以随时查看监控详情指标信息来观测其服务状态，但人不可能是一直去看，总有要休息的时候，监控往往伴随着告警，当监控指标发生异常，监控系统需要能及时通知到负责人** +**这样我们就完成了对 IoTDB 的监控，我们可以随时查看监控详情指标信息来观测其服务状态，但人不可能是一直去看，总有要休息的时候，监控往往伴随着告警，当监控指标发生异常，监控系统需要能及时通知到负责人** -**接下来我们就来一步一步教您配置 HertzBeat 系统里的阈值告警通知** +**接下来我们就来一步一步教您配置 HertzBeat 系统里的阈值告警通知** -#### 三. 在 HertzBeat 系统添加 IoTDB 指标阈值告警 +#### 三. 在 HertzBeat 系统添加 IoTDB 指标阈值告警 -1. 对某个重要指标配置阈值告警 +1. 对某个重要指标配置阈值告警 -路径：菜单 -> 告警阈值 -> 新增阈值 +路径：菜单 -> 告警阈值 -> 新增阈值 -- 选择配置的指标对象，IotDB监控有非常多的指标，其中有个指标关系到节点的状态 `cluster_node_status` -> `status` (节点状态，1=online 2=offline)。 -- 这里我们就配置当此指标 `status==2` 时发出告警，告警级别为**紧急告警**，一次即触发，具体如下图。 +- 选择配置的指标对象，IotDB监控有非常多的指标，其中有个指标关系到节点的状态 `cluster_node_status` -> `status` (节点状态，1=online 2=offline)。 +- 这里我们就配置当此指标 `status==2` 时发出告警，告警级别为**紧急告警**，一次即触发，具体如下图。 -![hertzbeat](/img/blog/monitor-iotdb-6.png) +![hertzbeat](/img/blog/monitor-iotdb-6.png) +2. 新增消息通知接收人 -2. 新增消息通知接收人 +路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 -路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 +消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 - -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 -- 在 HertzBeat 配置接收人参数如下。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 -![hertzbeat](/img/blog/alert-notice-1.png) - -3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +![hertzbeat](/img/blog/alert-notice-1.png) -![hertzbeat](/img/blog/alert-notice-2.png) +3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +![hertzbeat](/img/blog/alert-notice-2.png) -### 完毕，现在坐等告警消息过来了。叮叮叮叮 +### 完毕，现在坐等告警消息过来了。叮叮叮叮 ``` [HertzBeat告警通知] @@ -121,16 +119,16 @@ metricReporterList: 内容详情 : 监控到 IOTDB 节点 127.0.0.1 状态 OFFLINE, 请及时处理。 ``` -## 小结 +## 小结 -这篇实践文章带我们体验了如何使用 HertzBeat 监控 IoTDB 数据库指标数据，可以发现将 监控-告警-通知 集一体的 HertzBeat 在操作与使用方面更加的便捷，在页面上简单点一点就能把 IoTDB 纳入监控，再也不需要部署多个组件，写多个有门槛的YML配置文件了。 +这篇实践文章带我们体验了如何使用 HertzBeat 监控 IoTDB 数据库指标数据，可以发现将 监控-告警-通知 集一体的 HertzBeat 在操作与使用方面更加的便捷，在页面上简单点一点就能把 IoTDB 纳入监控，再也不需要部署多个组件，写多个有门槛的YML配置文件了。 IoTDB Github: https://github.com/apache/iotdb -HertzBeat Github: https://github.com/apache/hertzbeat +HertzBeat Github: https://github.com/apache/hertzbeat **欢迎了解使用Star支持哦！** 只需要一条docker命令即可安装体验heartbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -注意⚠️HertzBeat v1.2.3 版本支持 IoTDB v0.12 v0.13, 由于其v1.0刚发布, 暂未对此版本全部指标兼容。 +注意⚠️HertzBeat v1.2.3 版本支持 IoTDB v0.12 v0.13, 由于其v1.0刚发布, 暂未对此版本全部指标兼容。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md index d8a2b6ca37b..2ddf42275b3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md @@ -9,9 +9,9 @@ tags: [opensource, practice] ## 使用 HertzBeat 对 API 网关 Apache ShenYu 进行监控实践，5分钟搞定！ -### Apache ShenYu 介绍 +### Apache ShenYu 介绍 -> Apache ShenYu 一个异步的，高性能的，跨语言的，响应式的 API 网关。 +> Apache ShenYu 一个异步的，高性能的，跨语言的，响应式的 API 网关。 - 代理：支持Apache Dubbo，Spring Cloud，gRPC，Motan，SOFA，TARS，WebSocket，MQTT - 安全性：签名，OAuth 2.0，JSON Web令牌，WAF插件 @@ -22,19 +22,18 @@ tags: [opensource, practice] - 集群：NGINX、Docker、Kubernetes - 语言：提供.NET，Python，Go，Java客户端用于API注册 - -### HertzBeat 介绍 +### HertzBeat 介绍 > HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 > 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书)。 -> HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +> HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 ### 在 HertzBeat 5分钟搞定监控 Apache ShenYu -#### 操作前提，您已拥有 ShenYu 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 ShenYu 环境和 HertzBeat 环境。 -- ShenYu [部署安装文档](https://shenyu.apache.org/zh/docs/deployment/deployment-before) -- HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) +- ShenYu [部署安装文档](https://shenyu.apache.org/zh/docs/deployment/deployment-before) +- HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) #### 一. 在 ShenYu 端开启`metrics`插件，它将提供 metrics 接口数据。 @@ -44,11 +43,11 @@ tags: [opensource, practice] 1. 在网关的 `pom.xml` 文件中添加 `metrics插件` 的依赖。 ```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` 2. `metric`插件 采集默认是关闭的, 在网关的配置`yaml`文件中编辑如下内容： @@ -65,83 +64,81 @@ shenyu: jvm_enabled: true #开启jvm的监控指标 ``` -3. 重启 ShenYu网关, 打开浏览器或者用curl 访问 `http://ip:8090`, 就能看到metric数据了。 +3. 重启 ShenYu网关, 打开浏览器或者用curl 访问 `http://ip:8090`, 就能看到metric数据了。 -#### 二. 在 HertzBeat 监控页面添加 ShenYu 监控 +#### 二. 在 HertzBeat 监控页面添加 ShenYu 监控 -1. 点击新增 ShenYu 监控 +1. 点击新增 ShenYu 监控 -路径：菜单 -> 中间件监控 -> ShenYu监控 -> 新增ShenYu监控 +路径：菜单 -> 中间件监控 -> ShenYu监控 -> 新增ShenYu监控 -![hertzbeat](/img/blog/monitor-shenyu-1.png) +![hertzbeat](/img/blog/monitor-shenyu-1.png) -2. 配置监控 ShenYu 所需参数 +2. 配置监控 ShenYu 所需参数 在监控页面填写 ShenYu **服务IP**，**监控端口**(默认8090)，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/shenyu/) https://hertzbeat.com/docs/help/shenyu/ +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/shenyu/) https://hertzbeat.com/docs/help/shenyu/ -![hertzbeat](/img/blog/monitor-shenyu-1.png) +![hertzbeat](/img/blog/monitor-shenyu-1.png) -3. 完成✅,现在我们已经添加好对 ShenYu 的监控了，查看监控列表即可看到我们的添加项。 +3. 完成✅,现在我们已经添加好对 ShenYu 的监控了，查看监控列表即可看到我们的添加项。 -![hertzbeat](/img/blog/monitor-shenyu-3.png) +![hertzbeat](/img/blog/monitor-shenyu-3.png) -4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 ShenYu 的实时监控指标数据。 +4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 ShenYu 的实时监控指标数据。 -![hertzbeat](/img/blog/monitor-shenyu-4.png) +![hertzbeat](/img/blog/monitor-shenyu-4.png) -5. 点击**监控历史详情TAB** 即可浏览 ShenYu 的历史监控指标数据图表📈。 +5. 点击**监控历史详情TAB** 即可浏览 ShenYu 的历史监控指标数据图表📈。 -![hertzbeat](/img/blog/monitor-shenyu-5.png) +![hertzbeat](/img/blog/monitor-shenyu-5.png) ![hertzbeat](/img/blog/monitor-shenyu-6.png) **DONE！完成啦！通过上面几步，总结起来其实也就只用两步** - **第一步开启 ShenYu 端`metrics`插件功能** -- **第二步在 HertzBeat 监控页面配置IP端口添加监控即可** +- **第二步在 HertzBeat 监控页面配置IP端口添加监控即可** :::tip 通过上面的两步我们就完成了对 Apache ShenYu 的监控，我们可以在 HertzBeat 随时查看监控详情指标信息来观测其服务状态。 当然只是看肯定是不完美的，监控往往伴随着告警阈值，当 ShenYu 的某些指标超出我们的期望值或异常时，能及时的通知到我们对应的负责人，负责人收到通知处理问题，这样才是一个完整的监控告警流程。 ::: -**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，让 ShenYu 的指标异常时，及时通知给我们** - -#### 三. 在 HertzBeat 系统添加 ShenYu 指标阈值告警 +**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，让 ShenYu 的指标异常时，及时通知给我们** -1. 对某个重要指标配置告警阈值 +#### 三. 在 HertzBeat 系统添加 ShenYu 指标阈值告警 -路径：菜单 -> 告警阈值 -> 新增阈值 +1. 对某个重要指标配置告警阈值 -- 选择配置的指标对象，ShenYu 监控有非常多的指标，我们举例对 `打开的文件描述符的数量` `process_open_fds` -> `value` 这个指标进行阈值设置， 当服务端打开文件描述符数量大于3000时发出告警。 -- 这里我们就配置当此指标`process_open_fds` 的 `value>3000` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。 +路径：菜单 -> 告警阈值 -> 新增阈值 -![hertzbeat](/img/blog/monitor-shenyu-7.png) +- 选择配置的指标对象，ShenYu 监控有非常多的指标，我们举例对 `打开的文件描述符的数量` `process_open_fds` -> `value` 这个指标进行阈值设置， 当服务端打开文件描述符数量大于3000时发出告警。 +- 这里我们就配置当此指标`process_open_fds` 的 `value>3000` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。 +![hertzbeat](/img/blog/monitor-shenyu-7.png) 2. 新增消息通知接收人 -> 配置接收人，让告警消息知道要发给谁，用什么方式发。 +> 配置接收人，让告警消息知道要发给谁，用什么方式发。 -路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 +路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 -消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 +消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 -- 在 HertzBeat 配置接收人参数如下。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 -![hertzbeat](/img/blog/alert-notice-1.png) +![hertzbeat](/img/blog/alert-notice-1.png) -3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 > 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。 -![hertzbeat](/img/blog/alert-notice-2.png) - +![hertzbeat](/img/blog/alert-notice-2.png) -### 完毕，现在坐等告警消息过来啦。叮叮叮叮 +### 完毕，现在坐等告警消息过来啦。叮叮叮叮 ``` [HertzBeat告警通知] @@ -153,14 +150,14 @@ shenyu: 内容详情 : 请注意⚠️ ShenYu网关打开的文件描述符的数量为 3044 超过3000 ``` -## 小结 +## 小结 :::tip 这篇实践文章带我们体验了如何使用 HertzBeat 监控 Apache ShenYu 指标数据，可以发现将 `监控-告警-通知` 集一体的 HertzBeat 在操作与使用方面更加的便捷，在页面上简单点一点就能把 ShenYu 纳入监控，再也不需要部署多个组件，写多个有门槛的YML配置文件了。 ::: Apache ShenYu Github: https://github.com/apache/shenyu -HertzBeat Github: https://github.com/apache/hertzbeat +HertzBeat Github: https://github.com/apache/hertzbeat **欢迎了解使用Star支持哦！** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md index 16c8464fb36..60663c6041f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md @@ -9,33 +9,32 @@ tags: [opensource, practice] ## 使用 HertzBeat 对 线程池框架 DynamicTp 进行监控实践，5分钟搞定！ -### 线程池框架 DynamicTp 介绍 +### 线程池框架 DynamicTp 介绍 -> DynamicTp 是Jvm语言的基于配置中心的轻量级动态线程池，内置监控告警功能，可通过SPI自定义扩展实现。 +> DynamicTp 是Jvm语言的基于配置中心的轻量级动态线程池，内置监控告警功能，可通过SPI自定义扩展实现。 -- 支持对运行中线程池参数的动态修改，实时生效。 -- 实时监控线程池的运行状态，触发设置的报警策略时报警，报警信息推送办公平台。 -- 定时采集线程池指标数据，配合像 grafana 这种可视化监控平台做大盘监控。 +- 支持对运行中线程池参数的动态修改，实时生效。 +- 实时监控线程池的运行状态，触发设置的报警策略时报警，报警信息推送办公平台。 +- 定时采集线程池指标数据，配合像 grafana 这种可视化监控平台做大盘监控。 +### HertzBeat 介绍 -### HertzBeat 介绍 +> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 -> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 +- 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 +- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ +- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -- 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 -- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ -- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +### 在 HertzBeat 5分钟搞定监控 DynamicTp -### 在 HertzBeat 5分钟搞定监控 DynamicTp +#### 操作前提，您已拥有 DynamicTp 环境和 HertzBeat 环境。 -#### 操作前提，您已拥有 DynamicTp 环境和 HertzBeat 环境。 - -- DynamicTp [集成接入文档](https://dynamictp.cn/guide/use/quick-start.html) -- HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) +- DynamicTp [集成接入文档](https://dynamictp.cn/guide/use/quick-start.html) +- HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) #### 一. 在 DynamicTp 端暴露出`DynamicTp`指标接口 `/actuator/dynamic-tp`，它将提供 metrics 接口数据。 -1. 开启 SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 +1. 开启 SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 ```yaml management: @@ -79,81 +78,79 @@ management: ] ``` -#### 二. 在 HertzBeat 监控页面添加 DynamicTp 线程池监控 +#### 二. 在 HertzBeat 监控页面添加 DynamicTp 线程池监控 -1. 点击新增 DynamicTp 监控 +1. 点击新增 DynamicTp 监控 -路径：菜单 -> 中间件监控 -> DynamicTp监控 -> 新增DynamicTp监控 +路径：菜单 -> 中间件监控 -> DynamicTp监控 -> 新增DynamicTp监控 ![hertzbeat](/img/blog/monitor-dynamic-tp-1.png) -2. 配置监控 DynamicTp 所需参数 +2. 配置监控 DynamicTp 所需参数 在监控页面填写 DynamicTp **服务IP**，**监控端口**(默认8080)，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/dynamic_tp/) https://hertzbeat.com/docs/help/dynamic_tp/ +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/dynamic_tp/) https://hertzbeat.com/docs/help/dynamic_tp/ -![hertzbeat](/img/blog/monitor-dynamic-tp-2.png) +![hertzbeat](/img/blog/monitor-dynamic-tp-2.png) -3. 完成✅,现在我们已经添加好对 DynamicTp 的监控了，查看监控列表即可看到我们的添加项。 +3. 完成✅,现在我们已经添加好对 DynamicTp 的监控了，查看监控列表即可看到我们的添加项。 -![hertzbeat](/img/blog/monitor-dynamic-tp-1.png) +![hertzbeat](/img/blog/monitor-dynamic-tp-1.png) -4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 DynamicTp线程池 的实时监控指标数据。 +4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 DynamicTp线程池 的实时监控指标数据。 -![hertzbeat](/img/blog/monitor-dynamic-tp-3.png) +![hertzbeat](/img/blog/monitor-dynamic-tp-3.png) -5. 点击**监控历史详情TAB** 即可浏览 DynamicTp线程池 的历史监控指标数据图表📈。 +5. 点击**监控历史详情TAB** 即可浏览 DynamicTp线程池 的历史监控指标数据图表📈。 -![hertzbeat](/img/blog/monitor-dynamic-tp-4.png) +![hertzbeat](/img/blog/monitor-dynamic-tp-4.png) ![hertzbeat](/img/blog/monitor-dynamic-tp-5.png) **DONE！完成啦！通过上面几步，总结起来其实也就只用两步** - **第一步暴露 DynamicTp 端`metrics`端点`/actuator/dynamic-tp`** -- **第二步在 HertzBeat 监控页面配置IP端口添加监控即可** +- **第二步在 HertzBeat 监控页面配置IP端口添加监控即可** :::tip 通过上面的两步我们就完成了对 DynamicTp 的监控，我们可以在 HertzBeat 随时查看监控详情指标信息来观测其服务状态。 当然只是看肯定是不完美的，监控往往伴随着告警阈值，当 DynamicTp 的线程池指标超出我们的期望值或异常时，能及时的通知到我们对应的负责人，负责人收到通知处理问题，这样才是一个完整的监控告警流程。 ::: -**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，让 DynamicTp线程池 的指标异常时，及时通知给我们** +**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，让 DynamicTp线程池 的指标异常时，及时通知给我们** -#### 三. 在 HertzBeat 系统添加 DynamicTp线程池 指标阈值告警 +#### 三. 在 HertzBeat 系统添加 DynamicTp线程池 指标阈值告警 -1. 对某个重要指标配置告警阈值 +1. 对某个重要指标配置告警阈值 -路径：菜单 -> 告警阈值 -> 新增阈值 +路径：菜单 -> 告警阈值 -> 新增阈值 -- 选择配置的指标对象，DynamicTp监控主要是一些线程池相关指标，我们举例对 `运行超时线程数量` `thread_pool_running` -> `run_timeout_count` 这个指标进行阈值设置， 当线程运行超时数量大于1时发出告警。 -- 这里我们就配置当此指标`thread_pool_running` 的 `run_timeout_count>1` 时发出告警，告警级别为**严重告警**，三次即触发，具体如下图。 - -![hertzbeat](/img/blog/monitor-dynamic-tp-6.png) +- 选择配置的指标对象，DynamicTp监控主要是一些线程池相关指标，我们举例对 `运行超时线程数量` `thread_pool_running` -> `run_timeout_count` 这个指标进行阈值设置， 当线程运行超时数量大于1时发出告警。 +- 这里我们就配置当此指标`thread_pool_running` 的 `run_timeout_count>1` 时发出告警，告警级别为**严重告警**，三次即触发，具体如下图。 +![hertzbeat](/img/blog/monitor-dynamic-tp-6.png) 2. 新增消息通知接收人 -> 配置接收人，让告警消息知道要发给谁，用什么方式发。 +> 配置接收人，让告警消息知道要发给谁，用什么方式发。 -路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 +路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 -消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 +消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 -- 在 HertzBeat 配置接收人参数如下。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 -![hertzbeat](/img/blog/alert-notice-1.png) +![hertzbeat](/img/blog/alert-notice-1.png) -3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 > 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。 -![hertzbeat](/img/blog/alert-notice-2.png) - +![hertzbeat](/img/blog/alert-notice-2.png) -### 完毕，现在坐等告警消息过来啦。叮叮叮叮 +### 完毕，现在坐等告警消息过来啦。叮叮叮叮 ``` [HertzBeat告警通知] @@ -165,14 +162,14 @@ management: 内容详情 : DynamicTp has run timeout thread, count is 2 ``` -## 小结 +## 小结 :::tip 这篇实践文章带我们体验了如何使用 HertzBeat 监控 DynamicTp线程池 指标数据，可以发现集 `监控-告警-通知` 的 HertzBeat 在操作与使用方面更加的便捷，只需页面上简单点一点就能把 DynamicTp线程池 纳入监控并告警通知，再也不需要部署多个组件写YML配置文件那些繁琐操作了。 ::: DynamicTp Github: https://github.com/dromara/dynamic-tp -HertzBeat Github: https://github.com/apache/hertzbeat +HertzBeat Github: https://github.com/apache/hertzbeat **欢迎了解使用Star支持哦！** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md index abdd58e8f1c..72b996e62c5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md @@ -64,13 +64,10 @@ github：TJxiaobao 首先要在这里感谢🙏花城师兄，因为当时自己想学习一些优秀的 `Java` 项目。然后在吃饭的时候向师兄请教了一下有没有好的项目推荐，恰好这时师兄把我推荐给了tom哥。当我亲自使用了 `hertzbeat` 的时候真的是发现了新的大陆，相比较于自己之前接触简单的 `Java` 项目，不论是 `hertzbeat` 的架构设计，还是它的实用功能都深深折服了我。此时一颗 `想要贡献自己的一份力量` 的种子已经在我的心中种下。 - - ### 🌻 开始提交PR 在 Oct 20, 2022 是我第一次提交 `PR` 的时间，虽然本次 `PR` 是简单的翻译注释，看着技术含量不是很高。但是他也能让我更快的熟悉项目的业务逻辑和架构设计，能为以后的贡献打下坚实的基础。而这次 `PR` 也是我迈向开源的第一步，也是让我爱上开源的起点！ - ### 🌻 持续的开源贡献和收获 从第一次 `PR` 到现在，参加 `hertzbeat` 开源项目已经有一段时间了，也贡献了一小部分，也成长收获了很多。具体如下。 @@ -88,12 +85,10 @@ github：TJxiaobao - 2、开阔自己的眼界。 - 3、从大佬们身上学到了很多知识。 - ### 🌻 感谢社区小伙伴 感谢无偿帮助过我或给过我启发的小伙伴(排名不分先后)：tomsun28（tom哥），花城（师兄） - ### 🌻 对新人的一点建议 首先我也是一枚新手村的萌新啦，但是我可以把我的一些经验分享给大家，希望能给大家有所帮助。 @@ -103,14 +98,13 @@ github：TJxiaobao - 3、慢慢的尝试阅读源码，并理解。 - 4、如果遇见bug，可以直接反馈到 isses，也可以自己尝试解决嘿嘿。 - ## What is HertzBeat? > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需Agent的实时监控告警工具。应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Discord Slack Telegram)。 - +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 > 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ - +> > `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **Github: https://github.com/apache/hertzbeat** @@ -118,10 +112,11 @@ github：TJxiaobao ## ⛄ Supported -- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- 和更多您的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 +- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 +- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB +- Linux, Ubuntu, CentOS, Windows +- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +- Kubernetes, Docker +- 和更多您的自定义监控。 +- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md index df5b379f995..b41bc15de9a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md @@ -10,100 +10,97 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ## 使用开源实时监控工具 HertzBeat 对 Mysql 数据库监控告警实践，5分钟搞定！ -### Mysql 数据库介绍 +### Mysql 数据库介绍 > MySQL是一个开源关系型数据库管理系统，由瑞典MySQL AB 公司开发，属于 Oracle 旗下产品。MySQL 是最流行的开源关系型数据库管理系统之一，在 WEB 应用方面，MySQL是最好的 RDBMS (Relational Database Management System，关系数据库管理系统) 应用软件之一。 +### HertzBeat 介绍 -### HertzBeat 介绍 +> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 -> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 +- 集**监控-告警-通知为一体**，支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 +- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ +- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -- 集**监控-告警-通知为一体**，支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 -- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ -- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +### 在 HertzBeat 5分钟搞定对 Mysql 数据库监控 -### 在 HertzBeat 5分钟搞定对 Mysql 数据库监控 +#### 操作前提，您已拥有 Mysql 环境和 HertzBeat 环境。 -#### 操作前提，您已拥有 Mysql 环境和 HertzBeat 环境。 - -- Mysql [安装部署文档](https://www.runoob.com/mysql/mysql-install.html) +- Mysql [安装部署文档](https://www.runoob.com/mysql/mysql-install.html) - HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) -#### 在开源监控系统 HertzBeat 监控页面添加对 Mysql 数据库监控 +#### 在开源监控系统 HertzBeat 监控页面添加对 Mysql 数据库监控 -1. 点击新增 Mysql 监控 +1. 点击新增 Mysql 监控 -路径：菜单 -> 数据库监控 -> Mysql数据库 -> 新增Mysql数据库监控 +路径：菜单 -> 数据库监控 -> Mysql数据库 -> 新增Mysql数据库监控 ![hertzbeat](/img/blog/monitor-mysql-1.png) -2. 配置新增监控 Mysql 数据库所需参数 +2. 配置新增监控 Mysql 数据库所需参数 在监控页面填写 Mysql **服务IP**，**监控端口**(默认3306)，**账户密码等**，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/mysql/) https://hertzbeat.com/docs/help/mysql/ +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/mysql/) https://hertzbeat.com/docs/help/mysql/ -![hertzbeat](/img/blog/monitor-mysql-2.png) +![hertzbeat](/img/blog/monitor-mysql-2.png) -3. 完成✅,现在我们已经添加好对 Mysql数据库 的监控了，查看监控列表即可看到我们的添加项。 +3. 完成✅,现在我们已经添加好对 Mysql数据库 的监控了，查看监控列表即可看到我们的添加项。 -![hertzbeat](/img/blog/monitor-mysql-1.png) +![hertzbeat](/img/blog/monitor-mysql-1.png) -4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 Mysql数据库 的实时监控指标数据。 +4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 Mysql数据库 的实时监控指标数据。 -![hertzbeat](/img/blog/monitor-mysql-3.png) +![hertzbeat](/img/blog/monitor-mysql-3.png) -5. 点击**监控历史详情TAB** 即可浏览 Mysql数据库 的历史监控指标数据图表📈。 +5. 点击**监控历史详情TAB** 即可浏览 Mysql数据库 的历史监控指标数据图表📈。 ![hertzbeat](/img/blog/monitor-mysql-4.png) **DONE！完成啦！通过上面几步，总结起来其实也就只用一步即可** -- **在 HertzBeat 监控页面配置IP端口账户密码添加 Mysql 监控即可** +- **在 HertzBeat 监控页面配置IP端口账户密码添加 Mysql 监控即可** :::tip 通过上面的两步我们就完成了对 Mysql数据库 的监控，我们可以在 HertzBeat 随时查看监控详情指标信息来观测其服务状态。 当然只是看肯定是不完美的，监控往往伴随着告警阈值，当 Mysql 数据库的指标超出我们的期望值或异常时，能及时的通知到我们对应的负责人，负责人收到通知处理问题，这样才是一个完整的监控告警流程。 ::: -**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，让及时发现 Mysql 数据库的指标异常时，及时通知给我们** +**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，让及时发现 Mysql 数据库的指标异常时，及时通知给我们** -#### 三. 在 HertzBeat 系统添加 Mysql 数据库指标阈值告警 +#### 三. 在 HertzBeat 系统添加 Mysql 数据库指标阈值告警 -1. 对某个重要指标配置告警阈值 +1. 对某个重要指标配置告警阈值 -路径：菜单 -> 阈值规则 -> 新增阈值 +路径：菜单 -> 阈值规则 -> 新增阈值 -- 选择配置的指标对象，Mysql 数据库监控主要是数据库性能等相关指标，我们举例对 `查询缓存命中率` `cache` -> `query_cache_hit_rate` 这个指标进行阈值设置， 当Mysql的查询缓存命中率很低小于30%时发出告警。 -- 这里我们就配置当此指标`cache` 的 `query_cache_hit_rate<30` 时发出告警，告警级别为**严重告警**，三次即触发，具体如下图。 +- 选择配置的指标对象，Mysql 数据库监控主要是数据库性能等相关指标，我们举例对 `查询缓存命中率` `cache` -> `query_cache_hit_rate` 这个指标进行阈值设置， 当Mysql的查询缓存命中率很低小于30%时发出告警。 +- 这里我们就配置当此指标`cache` 的 `query_cache_hit_rate<30` 时发出告警，告警级别为**严重告警**，三次即触发，具体如下图。 -![hertzbeat](/img/blog/monitor-mysql-5.png) +![hertzbeat](/img/blog/monitor-mysql-5.png) ![hertzbeat](/img/blog/monitor-mysql-6.png) - 2. 新增消息通知接收人 -> 配置接收人，让告警消息知道要发给谁，用什么方式发。 +> 配置接收人，让告警消息知道要发给谁，用什么方式发。 -路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 +路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 -消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 +消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 -- 在 HertzBeat 配置接收人参数如下。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 -![hertzbeat](/img/blog/alert-notice-1.png) +![hertzbeat](/img/blog/alert-notice-1.png) -3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 > 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。 -![hertzbeat](/img/blog/alert-notice-2.png) - +![hertzbeat](/img/blog/alert-notice-2.png) -### 完毕，现在坐等告警消息过来啦。叮叮叮叮 +### 完毕，现在坐等告警消息过来啦。叮叮叮叮 ``` [HertzBeat告警通知] @@ -115,17 +112,17 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] 内容详情 : mysql db query_cache_hit_rate is too low, now is 20. ``` -## 小结 +## 小结 :::tip 这篇实践文章带我们体验了如何使用开源实时监控工具 HertzBeat 来监控 Mysql 数据库指标数据，可以发现集 `监控-告警-通知` 的 HertzBeat 在操作与使用方面更加的便捷，只需页面上简单点一点就能把 Mysql 数据库纳入监控并告警通知，再也不需要部署多个组件编写配置文件那些繁琐操作了。 ::: Mysql Github: https://github.com/mysql/mysql-server -HertzBeat Github: https://github.com/apache/hertzbeat +HertzBeat Github: https://github.com/apache/hertzbeat **欢迎了解使用支持Star哦！** -> 只需要一条docker命令即可安装体验heartbeat: +> 只需要一条docker命令即可安装体验heartbeat: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md index 3b491e6fe48..c80d7a5fcbb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md @@ -10,48 +10,48 @@ keywords: [开源监控系统, 操作系统监控, Linux监控] ## 使用开源实时监控工具 HertzBeat 对 Linux 操作系统的监控告警实践，5分钟搞定！ -### HertzBeat 介绍 +### HertzBeat 介绍 -> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 +> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 -- 集**监控-告警-通知为一体**，支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 -- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ -- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +- 集**监控-告警-通知为一体**，支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 +- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ +- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -Github: https://github.com/apache/hertzbeat +Github: https://github.com/apache/hertzbeat -### 在 HertzBeat 5分钟搞定对 Linux 的监控 +### 在 HertzBeat 5分钟搞定对 Linux 的监控 -#### 操作前提，您已拥有 Linux 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 Linux 环境和 HertzBeat 环境。 - HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) -#### 在开源监控系统 HertzBeat 监控页面添加对 Linux 操作系统监控 +#### 在开源监控系统 HertzBeat 监控页面添加对 Linux 操作系统监控 -1. 点击新增 Linux 监控 +1. 点击新增 Linux 监控 -路径：菜单 -> 操作系统监控 -> Linux操作系统 -> 新增Linux操作系统监控 +路径：菜单 -> 操作系统监控 -> Linux操作系统 -> 新增Linux操作系统监控 ![hertzbeat](/img/blog/monitor-linux-1.png) -2. 配置新增监控 Linux 所需参数 +2. 配置新增监控 Linux 所需参数 在监控页面填写 Linux **对端IP**，**SSH端口**(默认22)，**账户密码等**，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 https://hertzbeat.com/docs/help/mysql/ +其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 https://hertzbeat.com/docs/help/mysql/ -![hertzbeat](/img/blog/monitor-linux-2.png) +![hertzbeat](/img/blog/monitor-linux-2.png) -3. 完成✅,现在我们已经添加好对 Linux 的监控了，查看监控列表即可看到我们的添加项。 +3. 完成✅,现在我们已经添加好对 Linux 的监控了，查看监控列表即可看到我们的添加项。 -![hertzbeat](/img/blog/monitor-linux-3.png) +![hertzbeat](/img/blog/monitor-linux-3.png) -4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 Linux 的实时监控指标数据。 +4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 Linux 的实时监控指标数据。 -![hertzbeat](/img/blog/monitor-linux-4.png) +![hertzbeat](/img/blog/monitor-linux-4.png) ![hertzbeat](/img/blog/monitor-linux-7.png) -5. 点击**监控历史详情TAB** 即可浏览 Linux 的历史监控指标数据图表📈。 +5. 点击**监控历史详情TAB** 即可浏览 Linux 的历史监控指标数据图表📈。 ![hertzbeat](/img/blog/monitor-linux-5.png) @@ -59,113 +59,110 @@ Github: https://github.com/apache/hertzbeat **DONE！完成啦！不需要我们去部署agent或者各种繁琐操作，是不是很简单** -- **只需一步在 HertzBeat 监控页面配置IP端口账户密码添加 Linux 监控即可** +- **只需一步在 HertzBeat 监控页面配置IP端口账户密码添加 Linux 监控即可** ### Linux 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | :::tip 通过上面我们就完成了对 Linux 的监控，我们可以在 HertzBeat 随时查看Linux的各种指标状态和可用性。 当然不可能人工一直实时查看指标，监控往往伴随着告警阈值，当 Linux 的性能指标超出我们的阈值或Linux本身异常时，能及时的通知到我们对应的负责人，负责人收到通知处理，这样才是一个完整的监控告警流程。 ::: -**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，当 Linux 的指标异常时，及时通知给我们** +**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，当 Linux 的指标异常时，及时通知给我们** -#### 三. 在 HertzBeat 系统添加 Linux 指标阈值告警 +#### 三. 在 HertzBeat 系统添加 Linux 指标阈值告警 -1. 对某个重要指标配置告警阈值 +1. 对某个重要指标配置告警阈值 -路径：菜单 -> 阈值规则 -> 新增阈值 +路径：菜单 -> 阈值规则 -> 新增阈值 -- 选择配置的指标对象，Linux 监控主要是cpu 内存 磁盘 网络性能等相关指标，我们举例对 `CPU利用率` `cpu` -> `usage` 这个指标进行阈值设置， 当Linux cpu利用率大于90%时发出告警。 -- 这里我们就配置当此指标`cpu` 的 `usage>90` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。 +- 选择配置的指标对象，Linux 监控主要是cpu 内存 磁盘 网络性能等相关指标，我们举例对 `CPU利用率` `cpu` -> `usage` 这个指标进行阈值设置， 当Linux cpu利用率大于90%时发出告警。 +- 这里我们就配置当此指标`cpu` 的 `usage>90` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。 -![hertzbeat](/img/blog/monitor-linux-8.png) +![hertzbeat](/img/blog/monitor-linux-8.png) ![hertzbeat](/img/blog/monitor-linux-9.png) - 2. 新增消息通知接收人 -> 配置接收人，让告警消息知道要发给谁，用什么方式发。 +> 配置接收人，让告警消息知道要发给谁，用什么方式发。 -路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 +路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 -消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 +消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 -- 在 HertzBeat 配置接收人参数如下。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 -![hertzbeat](/img/blog/alert-notice-1.png) +![hertzbeat](/img/blog/alert-notice-1.png) -3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 > 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。 -![hertzbeat](/img/blog/alert-notice-2.png) - +![hertzbeat](/img/blog/alert-notice-2.png) -### 完毕，现在坐等告警消息过来啦。叮叮叮叮 +### 完毕，现在坐等告警消息过来啦。叮叮叮叮 ``` [HertzBeat告警通知] @@ -177,23 +174,23 @@ Github: https://github.com/apache/hertzbeat 内容详情 : The linux cpu usage is too high. now is 95. ``` -## 小结 +## 小结 :::tip 这篇实践文章带我们体验了如何使用开源实时监控工具 HertzBeat 来监控 Linux 指标数据，可以发现集 `监控-告警-通知` 的 HertzBeat 在操作与使用方面更加的便捷，只需页面上简单点一点就能把 Linux 纳入监控并告警通知，再也不需要部署多个组件编写配置文件那些繁琐操作了。 ::: -> 只需要一条docker命令即可安装体验heartbeat: +> 只需要一条docker命令即可安装体验heartbeat: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` ## What is HertzBeat? > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需Agent的实时监控告警工具。应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Discord Slack Telegram)。 - +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 > 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ - +> > `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **Github: https://github.com/apache/hertzbeat** @@ -201,10 +198,11 @@ Github: https://github.com/apache/hertzbeat ## ⛄ Supported -- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- 和更多您的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 +- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 +- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB +- Linux, Ubuntu, CentOS, Windows +- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +- Kubernetes, Docker +- 和更多您的自定义监控。 +- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md index a7843b11337..90c0b4e7f27 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md @@ -10,25 +10,20 @@ keywords: [开源监控系统, 告警系统, Linux监控] 官网: hertzbeat.com | tancloud.cn - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a9629ef5bb6e486cacddb899f1495c6e~tplv-k3u1fbpfcp-zoom-1.image) - - ### What is HertzBeat? > HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 > 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 > 支持更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 - +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 - +> > 您相信只需定义YML就能立刻适配一款K8s或Docker等新的监控类型吗？ - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** @@ -49,8 +44,7 @@ keywords: [开源监控系统, 告警系统, Linux监控] - 修复若干BUG，更完善的文档，重构了代码。 ----- - +--- 只需要一条docker命令即可安装体验heartbeat `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` @@ -89,7 +83,6 @@ Feature： 26. [[webapp] change alert define trigger times from max 10 to max 999 #706](https://github.com/apache/hertzbeat/pull/706) @Grass-Life 27. [[doc] change default locale i18n from zh-cn to en #725](https://github.com/apache/hertzbeat/pull/725) - Bugfix. 1. [[collector] bugfix oracle query error: ORA-01000 happen #618](https://github.com/apache/hertzbeat/pull/618) @@ -115,6 +108,7 @@ Bugfix. 21. [bugfix job metrics set concurrent modification exception #723](https://github.com/apache/hertzbeat/pull/723) 22. [[script] modified the linux memory metrics specified script code #719](https://github.com/apache/hertzbeat/pull/719) 23. [[webapp] bugfix the cover of the big screen is too small #724](https://github.com/apache/hertzbeat/pull/724) + ---- 升级注意⚠️. @@ -122,6 +116,7 @@ Bugfix. 对于之前使用iotdb或者tdengine来存储指标数据的用户，需要修改 application.yml 来关闭JPA存储 `warehouse.store.jpa.enabled` 如下: 修改 `application.yml` 并设置 `warehouse.store.jpa.enabled` 参数为 false + ``` warehouse: store: @@ -130,23 +125,24 @@ warehouse: ``` 执行SQL脚本 + ``` ALTER table hzb_monitor modify job_id bigint default null; COMMIT; ``` ----- +--- ## ⛄ Supported -- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB, Redis集群 -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch -- 和更多你的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 +- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 +- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB, Redis集群 +- Linux, Ubuntu, CentOS, Windows +- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +- Kubernetes, Docker +- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch +- 和更多你的自定义监控。 +- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 ---- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md index 3c05f91b58f..49c2d8121f1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md @@ -10,21 +10,21 @@ keywords: [开源监控系统, SpringBoot监控, 监控告警] ## 使用开源实时监控工具 HertzBeat 对 SpringBoot2 应用的监控告警实践，5分钟搞定！ -### HertzBeat 介绍 +### HertzBeat 介绍 -> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 +> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 -- 集**监控-告警-通知为一体**，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 -- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ -- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +- 集**监控-告警-通知为一体**，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Slack Discord Telegram)。 +- 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ +- HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -Github: https://github.com/apache/hertzbeat +Github: https://github.com/apache/hertzbeat -### 在 HertzBeat 5分钟搞定对 SpringBoot2 应用的监控 +### 在 HertzBeat 5分钟搞定对 SpringBoot2 应用的监控 -#### 操作前提，您已拥有 SpringBoot2 应用环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 SpringBoot2 应用环境和 HertzBeat 环境。 -- HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) +- HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) #### 一. 在 SpringBoot2 应用端暴露出`actuator`指标接口，它将提供 metrics 接口数据。 @@ -79,82 +79,79 @@ management: } ``` -#### 在开源监控系统 HertzBeat 监控页面添加对 SpringBoot2 应用监控 +#### 在开源监控系统 HertzBeat 监控页面添加对 SpringBoot2 应用监控 -1. 点击新增 SpringBoot2 监控 +1. 点击新增 SpringBoot2 监控 -路径：菜单 -> 应用服务监控 -> SpringBoot2 -> 新增SpringBoot2监控 +路径：菜单 -> 应用服务监控 -> SpringBoot2 -> 新增SpringBoot2监控 ![hertzbeat](/img/blog/monitor-springboot2-1.png) -2. 配置新增监控 SpringBoot2 所需参数 +2. 配置新增监控 SpringBoot2 所需参数 在监控页面填写 SpringBoot2应用 **对端IP**，**服务端口**(默认8080)，**账户密码等**，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 https://hertzbeat.com/docs/help/ +其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 https://hertzbeat.com/docs/help/ -![hertzbeat](/img/blog/monitor-springboot2-2.png) +![hertzbeat](/img/blog/monitor-springboot2-2.png) -3. 完成✅,现在我们已经添加好对 SpringBoot2应用 的监控了，查看监控列表即可看到我们的添加项。 +3. 完成✅,现在我们已经添加好对 SpringBoot2应用 的监控了，查看监控列表即可看到我们的添加项。 -![hertzbeat](/img/blog/monitor-springboot2-3.png) +![hertzbeat](/img/blog/monitor-springboot2-3.png) -4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 SpringBoot2应用 的实时监控指标数据。 +4. 点击监控列表项的**操作**->**监控详情图标** 即可浏览 SpringBoot2应用 的实时监控指标数据。 ![hertzbeat](/img/blog/monitor-springboot2-4.png) -5. 点击**监控历史详情TAB** 即可浏览 SpringBoot2应用 的历史监控指标数据图表📈。 +5. 点击**监控历史详情TAB** 即可浏览 SpringBoot2应用 的历史监控指标数据图表📈。 ![hertzbeat](/img/blog/monitor-springboot2-5.png) **DONE！完成啦！不需要我们去部署agent或者各种繁琐操作，是不是很简单** -- **只需一步在 HertzBeat 监控页面配置IP端口添加 SpringBoot2应用 监控即可** - +- **只需一步在 HertzBeat 监控页面配置IP端口添加 SpringBoot2应用 监控即可** :::tip 通过上面我们就完成了对 SpringBoot2应用 的监控，我们可以在 HertzBeat 随时查看SpringBoot2应用的各种指标状态和可用性。 当然不可能人工一直实时查看指标，监控往往伴随着告警阈值，当 SpringBoot2应用 的性能指标超出我们的阈值或SpringBoot2应用本身异常时，能及时的通知到我们对应的负责人，负责人收到通知处理，这样才是一个完整的监控告警流程。 ::: -**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，当 SpringBoot2应用 的指标异常时，及时通知给我们** +**接下来我们就来一步一步演示如何配置 HertzBeat 系统里的阈值告警通知，当 SpringBoot2应用 的指标异常时，及时通知给我们** -#### 三. 在 HertzBeat 系统添加 SpringBoot2应用 指标阈值告警 +#### 三. 在 HertzBeat 系统添加 SpringBoot2应用 指标阈值告警 -1. 对某个重要指标配置告警阈值 +1. 对某个重要指标配置告警阈值 -路径：菜单 -> 阈值规则 -> 新增阈值 +路径：菜单 -> 阈值规则 -> 新增阈值 -- 选择配置的指标对象，SpringBoot2应用 监控主要是 堆栈内存 线程等相关指标，我们举例对 `状态线程数` `threads` -> `threads` 这个指标进行阈值设置， 当`runnable`状态的线程数量大于300时发出告警。 -- 这里我们就配置当此指标`size`,`state` 的 `equals(state,"runnable"") && size>300` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。 +- 选择配置的指标对象，SpringBoot2应用 监控主要是 堆栈内存 线程等相关指标，我们举例对 `状态线程数` `threads` -> `threads` 这个指标进行阈值设置， 当`runnable`状态的线程数量大于300时发出告警。 +- 这里我们就配置当此指标`size`,`state` 的 `equals(state,"runnable"") && size>300` 时发出告警，告警级别为**警告告警**，三次即触发，具体如下图。 -![hertzbeat](/img/blog/monitor-springboot2-6.png) +![hertzbeat](/img/blog/monitor-springboot2-6.png) ![hertzbeat](/img/blog/monitor-springboot2-7.png) - 2. 新增消息通知接收人 -> 配置接收人，让告警消息知道要发给谁，用什么方式发。 +> 配置接收人，让告警消息知道要发给谁，用什么方式发。 -路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 +路径：菜单 -> 告警通知 -> 告警接收人 -> 新增接收人 -消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 +消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 -- 在 HertzBeat 配置接收人参数如下。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 -![hertzbeat](/img/blog/alert-notice-1.png) +![hertzbeat](/img/blog/alert-notice-1.png) -3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 +3. 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】 > 配置告警通知策略，让告警消息与接收人绑定，这样就能决定哪些告警发给哪个人。 -![hertzbeat](/img/blog/alert-notice-2.png) - +![hertzbeat](/img/blog/alert-notice-2.png) -### 完毕，现在坐等告警消息过来啦。叮叮叮叮 +### 完毕，现在坐等告警消息过来啦。叮叮叮叮 ``` [HertzBeat告警通知] @@ -166,17 +163,17 @@ management: 内容详情 : The springboot2 service's runnable state threads num is over 300, now is 444. ``` -## 小结 +## 小结 :::tip 这篇实践文章带我们体验了如何使用开源实时监控工具 HertzBeat 来监控 SpringBoot2应用 指标数据，可以发现集 `监控-告警-通知` 的 HertzBeat 在操作与使用方面更加的便捷，只需页面上简单点一点就能把 SpringBoot2应用 纳入监控并告警通知，再也不需要部署多个组件编写配置文件那些繁琐操作了。 ::: -> 只需要一条docker命令即可安装体验heartbeat: +> 只需要一条docker命令即可安装体验heartbeat: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -## 更强大 +## 更强大 > 通过上面的简单步骤我们实现了对SpringBoot2的监控，但里面的内置指标固定不满足需要，是否能自定义监控更多SpringBoot2的指标呢？答案当然是可以的，通过在页面上的**监控定义**->**SpringBoot2**随时通过编辑如下的YML配置文件自定义添加修改想要监控的性能指标。 @@ -185,10 +182,10 @@ management: ## What is HertzBeat? > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需Agent的实时监控告警工具。应用服务，数据库，操作系统，中间件，云原生，网络等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Discord Slack Telegram)。 - +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 > 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ - +> > `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **Github: https://github.com/apache/hertzbeat** @@ -196,11 +193,12 @@ management: ## ⛄ Supported -- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- CiscoSwitch, HpeSwitch, HuaweiSwitch, TpLinkSwitch -- 和更多的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 +- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 +- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB +- Linux, Ubuntu, CentOS, Windows +- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +- Kubernetes, Docker +- CiscoSwitch, HpeSwitch, HuaweiSwitch, TpLinkSwitch +- 和更多的自定义监控。 +- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md index 8cf642bc3a4..d68058fec9d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md @@ -10,25 +10,20 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 官网: hertzbeat.com | tancloud.cn - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a9629ef5bb6e486cacddb899f1495c6e~tplv-k3u1fbpfcp-zoom-1.image) - - ### What is HertzBeat? > HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 > 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 > 支持更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 - +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 - +> > 您相信只需定义YML就能立刻适配一款K8s或Docker等新的监控类型吗？ - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** @@ -47,15 +42,14 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 若之前使用的TDengine时序数据库，需升级至TDengine3.0+ - 需要执行SQL升级脚本 + ``` ALTER table hzb_alert_define modify field varchar(255) default null; COMMIT; ``` ----- - +--- ## ⛄ 已支持 > 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! @@ -70,7 +64,7 @@ COMMIT; - 和更多自定义监控模版。 - 通知支持 Discord Slack Telegram 邮件 钉钉 微信 飞书 短信 Webhook。 ----- +--- **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md index 6035efe29ed..ad93e35571a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md @@ -56,14 +56,13 @@ $ docker run -p 4000-4004:4000-4004 \ 2. 使用```$ docker ps | grep greptime```查看 GreptimeDB 是否启动成功 - #### 安装部署 HertzBeat 具体可以参考 [官方文档](https://hertzbeat.com/zh-cn/docs/start/docker-deploy) 1. Docker 安装 HertzBeat -```shell +```shell $ docker run -d -p 1157:1157 \ -e LANG=zh_CN.UTF-8 \ -e TZ=Asia/Shanghai \ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md index 81d063c94af..03509304667 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md @@ -10,7 +10,6 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 官网: hertzbeat.com | tancloud.cn - ![hertzBeat](/img/home/0.png) ### HertzBeat 介绍 @@ -19,13 +18,11 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] > 致力于**易用友好**，全 WEB 页面操作，鼠标点一点就能监控告警，零上手学习成本。 > 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 > 支持更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 - +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 - ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** @@ -34,7 +31,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] **这次累计 27 位小伙伴们的辛苦贡献才出来了这个令人欣喜的版本。 感谢他们！爱心💗** -这个版本我们支持对**freebsd, debian, opensuse, redhat, apache doris**等新的监控类型和指标。 +这个版本我们支持对**freebsd, debian, opensuse, redhat, apache doris**等新的监控类型和指标。 - 支持WEB页面配置邮件服务器，取代之前的文件配置 - 支持告警收敛，是否遇到了重复告警频繁发送，有了告警收敛马上解决 @@ -42,11 +39,9 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - 新的监控中心页面，聚合所有监控类型，不用像之前那样切来切去了。 - 支持标签分组展示，把同一业务类别的监控们分组标记，统一管理。 - 阈值配置不仅仅有表达式，还支持更人性化的操作UI，之前的表达式对新人不太友好很容易出错，现在可以直接UI操作啦，它可以和表达式互相切换。 -- 还有HTTP ipv6等更多功能。 - -修复了大量BUG，完善文档代码，提高了整体的稳定可用性。更多新功能欢迎探索！ - +- 还有HTTP ipv6等更多功能。 +修复了大量BUG，完善文档代码，提高了整体的稳定可用性。更多新功能欢迎探索！ 只需要一条docker命令即可安装体验hertzbeat: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` @@ -54,8 +49,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 若dockerhub网络超时，可以使用下面命令: `docker run -d -p 1157:1157 --name hertzbeat quay.io/tancloud/hertzbeat` ----- - +--- ## ⛄ 已支持 > 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! @@ -70,10 +64,10 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - 和更多自定义监控模版。 - 通知支持 Discord Slack Telegram 邮件 钉钉 微信 飞书 短信 Webhook。 ----- +--- -**欢迎star三连来支持我们** +**欢迎star三连来支持我们** **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md index 97126e42bd4..02d1abc665a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system, Linux monitoring] --- - ![hertzBeat](/img/home/0.png) ### 什么是 HertzBeat? @@ -23,26 +22,25 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式消息及时送达。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 - -![hertzBeat](/img/docs/hertzbeat-arch.png) +![hertzBeat](/img/docs/hertzbeat-arch.png) **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** -### 集群版来啦 +### 集群版来啦 我们之前的hertzbeat一直是单机版本，组件代码模块化但不支持采集器独立部署，所支持的监控数量上限受到了单节点的天然限制，且无法应对多个隔离网络的资源的统一纳管。 -经过一个多月的迭代，我们重写了采集任务调度，采集器独立部署，设计单机版和集群版用同一套代码方便后续的维护升级，单机集群两种模式可相互切换无感知。最终很高兴，集群版如期与大家见面了。 +经过一个多月的迭代，我们重写了采集任务调度，采集器独立部署，设计单机版和集群版用同一套代码方便后续的维护升级，单机集群两种模式可相互切换无感知。最终很高兴，集群版如期与大家见面了。 -集群版不仅仅给我们带来了更强大的监控性能，更有云边协同等功能让人充满想象。 +集群版不仅仅给我们带来了更强大的监控性能，更有云边协同等功能让人充满想象。 #### 高性能集群 -- 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 +- 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 +- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 - 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 ![hertzbeat](/img/docs/cluster-arch.png) @@ -53,31 +51,29 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 在多个网络不相通的隔离网络中，在以往的方案中我们需要在每个网络都部署一套监控系统，这导致数据不互通，管理部署维护都不方便。 HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采集器，添加监控时指定采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主 HertzBeat 服务统一调度管理展示。 -这多用于多个隔离数据中心或不同厂商云资源和云下资源的统一监控场景。 +这多用于多个隔离数据中心或不同厂商云资源和云下资源的统一监控场景。 ![hertzbeat](/img/docs/cluster-arch.png) -### 为什么要开源集群版? +### 为什么要开源集群版? 往往一些做需要商业化的开源产品的策略会是单机版作为玩具给小玩家们的入门使用，然后集群版作为闭源产品给有需求的氪金玩家付费使用。这样的模式是可以说非常不错的且值得肯定的，即保证开源也得到了收益，也适用于很多开源项目的发展策略，可能会在商业路径上走得更通顺点。 网络上有些人会对这样的分单机和集群版的开源项目嗤之以鼻，觉得它们是伪开源，开源是噱头，他们觉得开源应该什么都开源免费出来，开源团队什么都应该无私奉献出来。。。。很无语这类人，有投入才有回报，当你免费使用着开源软件并得到价值的时候，是否应该想一想你付出给开源软件了什么而不是一味的索取。 那回到正题，我们又为什么要开源集群版？仅因为热爱开源？如果说我们还在少年可能这话你信，但一个快奔30还有家庭责任的人说出这话你信吗，我自己都不信😂。 -首先我们来看看开源能带来什么，或者为什么要做开源。最开始全职开源的想法很简单，做自己喜欢的开源产品(已实现)，程序员的梦想能部署在成千上万的服务器上(看下载量已实现)，然后基于此开源产品挣钱(暂未哭)。 +首先我们来看看开源能带来什么，或者为什么要做开源。最开始全职开源的想法很简单，做自己喜欢的开源产品(已实现)，程序员的梦想能部署在成千上万的服务器上(看下载量已实现)，然后基于此开源产品挣钱(暂未哭)。 - 用户流量。开源项目免费提供给用户和开发者，吸引用户使用，宣传等方面都有优势。 - 用户信任。开源的产品天生容易获取用户的信任和使用耐心，或者说降低用户的信任门槛。 - 社区协作。开源的产品可以吸引到顶级贡献者一起贡献，接收用户的反馈issue，pr贡献等，在社区的驱动下使开源项目越来越好，正向反馈后也会有更多人参与和使用。社区协作我觉得这是开源的意义，而且这样不仅仅只是程序员之间的贡献代码协作，用户都是协作对象(比如我们这个项目有大量的运维朋友贡献代码和文档)，如果是仅仅代码开源而不社区协作，那还不如放个安装包给别人免费使用下载就好。 -- 产品生态。这对一些需要生态的产品是需要的，比如hertzbeat，需要支持对接各种类型协议的监控类型，大量的监控模版。一个好的开源项目生态才能吸引到其它贡献者贡献和分享，在生态中互通有无，最终大家在生态中都受益。这在闭源程序中是很难做到的。 +- 产品生态。这对一些需要生态的产品是需要的，比如hertzbeat，需要支持对接各种类型协议的监控类型，大量的监控模版。一个好的开源项目生态才能吸引到其它贡献者贡献和分享，在生态中互通有无，最终大家在生态中都受益。这在闭源程序中是很难做到的。 上面几点，重在社区协作和产品生态，这也是开源集群版的原因，只有卷开源产品卷自己到更强的产品力，比如集群这一技术特性天生会吸引到开发者(而且集群本身就是我们社区协作的产物)，会吸引到更多的用户和贡献者使用反馈大家一起迭代，社区驱动进而正向促进开源项目和满足用户功能体验。 -而对于开源商业化，开源商业化的前提是得有个真正好的，受欢迎，被广泛使用的开源产品，然后在此基础上做商业化挣钱。 +而对于开源商业化，开源商业化的前提是得有个真正好的，受欢迎，被广泛使用的开源产品，然后在此基础上做商业化挣钱。 对了这里再说下开源不等同于免费，基于HertzBeat二次开发需保留logo，名称，页面脚注，版权等。 免费使用不是白嫖，这种破坏开源协议的才是，目前发现大量白嫖怪，小心点哈你们。我每年正月初七都会祝你们用这些钱吃的安心，住的放心，玩的开心哈。(仅个人言论不代表社区) - -### 尝试部署集群版 - +### 尝试部署集群版 1. `docker` 环境仅需一条命令即可开始 @@ -94,18 +90,17 @@ HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采 ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_IP=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。 - `-e MANAGER_IP=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 - `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) - ----- - +--- ### 更多的 v1.4.0 版本更新 -> 更多版本新功能更新欢迎探索，感谢社区小伙伴们的辛苦贡献，爱心💗! +> 更多版本新功能更新欢迎探索，感谢社区小伙伴们的辛苦贡献，爱心💗! * [doc] add v1.3.2 publish doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1075 * remove elasticsearch unused param index by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1080 @@ -155,7 +150,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN * [doc] add collector clusters document by @tomsun28 in https://github.com/apache/hertzbeat/pull/1161 * [hertzbeat] release hertzbeat version v1.4.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1168 ----- +--- ## ⛄ 已支持 @@ -178,5 +173,5 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 欢迎star一波来支持我们哦。 **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md index ee2e8f496da..6adbd15b1fd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) 很高兴迎来了新的社区`Committer`，和其它贡献者不一样的是`logicz`来自讯飞的运维实施岗位而不是开发岗位，但不管是代码还是文档等贡献质量都非常高👍。这也是我们`HertzBeat`与其它开源项目不一样的地方，因为用户群体更多面向运维开发，在我们139位贡献者中运维工程师的占比超30%，这打破了开源项目的协作贡献对象都是开发岗位的固有认知，这说明不管是运维工程师还是测试工程师对开源项目的贡献参与都是非常热情的，而不仅仅只是作为开源协作的旁观者。开源项目的参与并不是只专属于某一类人群，而是面向所有的想来参与的人，可能是一篇文档，一个脚本或者一段代码，想象一下你参与的开源项目被部署到成千上万的服务器上运行跑起来，帮助到他人被使用或者浏览Review讨论，git记录永留存，这也许就是参与开源项目的意义。 @@ -37,29 +36,29 @@ github：zqr10159 **贡献**： -* 实现实时数据存入Redis自定义db +* 实现实时数据存入Redis自定义db -* 新增历史数据存入GreptimeDB +* 新增历史数据存入GreptimeDB -* 提供监控批量导入、导出为xlsx和yml文件功能 +* 提供监控批量导入、导出为xlsx和yml文件功能 -* 提供Web页面自定义邮件服务器设置功能 +* 提供Web页面自定义邮件服务器设置功能 -* 提供Apache doris FE,BE监控模板 +* 提供Apache doris FE,BE监控模板 -* 实现ServerChan(Server酱)告警推送通知 +* 实现ServerChan(Server酱)告警推送通知 -* 接入第三方告警(腾讯云)，实现第三方告警与Hertzbeat告警统一推送 +* 接入第三方告警(腾讯云)，实现第三方告警与Hertzbeat告警统一推送 -* 修复导入、导出监控时不含采集器信息等bug +* 修复导入、导出监控时不含采集器信息等bug -* 若干文档的更新 +* 若干文档的更新 **收获**： -* Hertzbeat真的是个很优秀的项目，在项目部署方面，脚本和配置都非常规范，我自己写的很多项目都有借鉴 +* Hertzbeat真的是个很优秀的项目，在项目部署方面，脚本和配置都非常规范，我自己写的很多项目都有借鉴 -* 最重要的还是收获到了开源精神，大家在一个社区里面共同交流、进步 +* 最重要的还是收获到了开源精神，大家在一个社区里面共同交流、进步 ## 感谢社区小伙伴 @@ -67,8 +66,8 @@ github：zqr10159 ## 对新人的一点建议 -* 开源不易，要能够坚持下来，与大家分享自己的成果是很有成就感的一件事情 -* 养成良好的代码习惯，代码可以写的不好，注释一定要写清楚，方便其他人阅读和修改你的代码 +* 开源不易，要能够坚持下来，与大家分享自己的成果是很有成就感的一件事情 +* 养成良好的代码习惯，代码可以写的不好，注释一定要写清楚，方便其他人阅读和修改你的代码 ## 什么是 HertzBeat? @@ -76,15 +75,14 @@ HertzBeat 赫兹跳动是一个拥有强大自定义监控能力，高性能集 ### 特点 -* 集 **监控+告警+通知** 为一体，支持对应用服务，数据库，操作系统，中间件，云原生，网络等监控阈值告警通知一步到位。 -* 易用友好，无需 `Agent`，全 `WEB` 页面操作，鼠标点一点就能监控告警，零上手学习成本。 -* 将 `Http,Jmx,Ssh,Snmp,Jdbc` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ -* 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 -* 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 +* 集 **监控+告警+通知** 为一体，支持对应用服务，数据库，操作系统，中间件，云原生，网络等监控阈值告警通知一步到位。 +* 易用友好，无需 `Agent`，全 `WEB` 页面操作，鼠标点一点就能监控告警，零上手学习成本。 +* 将 `Http,Jmx,Ssh,Snmp,Jdbc` 等协议规范可配置化，只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？ +* 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 +* 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 - Github: https://github.com/apache/hertzbeat 欢迎更多的用户参与到`HertzBeat`的开源协作中来，不管是一个错别字还是标点符号我们都非常欢迎。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md index 25ae9bb91f3..bb29c6c9d0a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md @@ -22,7 +22,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - **监控指标名称国际化** 用户可以看指标的中英文名称啦，欢迎一起完善监控模版里面的i18n国际化资源 - **支持kubernetes helm charts一键部署** 见 https://artifacthub.io/packages/search?repo=hertzbeat -**更多的特性和BUG修复，稳定性提示** 感谢 @zqr10159 @Carpe-Wang @luxx-lq @l646505418 @LINGLUOJUN @luelueking @qyaaaa @novohit @gcdd1993 +**更多的特性和BUG修复，稳定性提示** 感谢 @zqr10159 @Carpe-Wang @luxx-lq @l646505418 @LINGLUOJUN @luelueking @qyaaaa @novohit @gcdd1993 ### 上效果图: @@ -46,7 +46,6 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] image - ### 什么是 HertzBeat? [HertzBeat 赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，高性能集群，无需 Agent 的开源实时监控告警系统。 @@ -59,8 +58,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式消息及时送达。 - -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -68,10 +66,8 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] **Gitee: https://gitee.com/hertzbeat/hertzbeat** - ### 尝试部署 - 1. `docker` 环境仅需一条命令即可开始 ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` @@ -87,14 +83,14 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。 - `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 - `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) ----- - +--- ## ⛄ 已支持 > 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! @@ -111,8 +107,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 和更多自定义监控模版。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱`。 ----- +--- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md index 7aec4a52016..5e18cd2ba5d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md @@ -16,12 +16,12 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - **消息通知模版特性，开源之夏课题** - **支持华为云OBS存储监控模版文件** -- **支持MQTT消息服务器 emqx 监控** +- **支持MQTT消息服务器 emqx 监控** - **支持对 udp 端口可用性监控** - **更多的特性功能支持和BUG修复** - **安装包内置JDK一键启动** -**更多的特性和BUG修复欢迎使用探索，1.4.2 版本共有 13 位社区小伙伴们参与，感谢他们的贡献❤️** +**更多的特性和BUG修复欢迎使用探索，1.4.2 版本共有 13 位社区小伙伴们参与，感谢他们的贡献❤️** ### 什么是 HertzBeat? @@ -35,8 +35,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -44,10 +43,8 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] **Gitee: https://gitee.com/hertzbeat/hertzbeat** - ### 尝试部署 - 1. `docker` 环境仅需一条命令即可开始 ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` @@ -63,14 +60,14 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。 - `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 - `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) ----- - +--- ## ⛄ 已支持 > 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! @@ -87,7 +84,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 和更多自定义监控模版。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱`。 ----- +--- **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** @@ -113,3 +110,4 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - ⬇️ [hertzbeat-collector-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_arm64_1.4.2.tar.gz) - ⬇️ [hertzbeat-collector-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_amd64_1.4.2.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-windows64_1.4.2.zip) + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md index 285097da988..4550a1f4278 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md @@ -40,7 +40,6 @@ keywords: [open source monitoring system, alerting system] ### 尝试部署 - 1. `docker` 环境仅需一条命令即可开始 ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` @@ -56,14 +55,14 @@ keywords: [open source monitoring system, alerting system] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。 - `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 - `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) ----- - +--- ## ⛄ 已支持 > 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! @@ -80,13 +79,12 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 和更多自定义监控模版。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱`。 ----- +--- **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -151,7 +149,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN **Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.2...v1.4.3 ----- +--- ## ⛄ Supported @@ -167,7 +165,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** ### **下载链接** @@ -190,3 +188,4 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - ⬇️ [hertzbeat-collector-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_arm64_1.4.3.tar.gz) - ⬇️ [hertzbeat-collector-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_amd64_1.4.3.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-windows64_1.4.3.zip) + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md index 895dd782421..c699daba0a1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) > 热烈欢迎 HertzBeat 有三位小伙伴新晋社区 Committer, 让我们来了解下他们的开源经历吧！ @@ -39,17 +38,11 @@ keywords: [open source monitoring system, alerting system] - 接触到了很优秀的开源社区，提升了相关领域的技术水平。 - 感谢Tom哥和我的ospp导师郑晨鑫，他们在我接触开源社区的过程中给出了许多帮助和建议。目前我仍然在社区中负责部分代码的开发，希望Hertzbeat以后可以越来越好！ - - ----- - +--- # New Committer - 淞筱 - - **姓名：周书胜** **河南师范大学大三学生** @@ -67,13 +60,11 @@ keywords: [open source monitoring system, alerting system] * 支持Spring Gateway、Apache Spark、Apache Hive等服务指标采集 * 自定义nginx、pop3协议，对Nginx，POP3邮箱服务器进行指标采集，并添加相应帮助文档 - ## 收获 * 接触了更加优秀、结构更加复杂的大型项目，提高了编程和解决问题的能力 * 将理论知识付诸于实践，收获了JUC，微服务相关的开发经验，以及宝贵的项目经历 - ## 感谢社区小伙伴 感谢HertzBeat的作者、HertzBeat/Sms4j Committer铁甲小宝同学、Sms4j Committer东风同学，在我遇到自己不能解决的问题时，常常向三位哥哥请教，他们也总是不厌其烦，耐心的帮助我解决问题，实在是无以言表。 @@ -85,14 +76,10 @@ keywords: [open source monitoring system, alerting system] * 初次参与开源项目时，可以从简单的任务开始。逐渐熟悉项目的代码和流程，并逐步承担更复杂的任务。 * 如果遇到自己无法解决的问题时，可以多多请教社区的小伙伴们。 - - ----- +--- # New Committer - 东风 - - **姓名：张洋** **河南师范大学应届生** @@ -126,7 +113,6 @@ keywords: [open source monitoring system, alerting system] - issue和pr是你了解的项目的敲门砖，一点要敢于讨论并发表观点。 - 贡献不分大小，要敢于尝试，并不断提升自己。 - ---- ## 什么是 HertzBeat? @@ -142,10 +128,8 @@ keywords: [open source monitoring system, alerting system] - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 - **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md index 6d60f9bb1ee..cbee4825d83 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md @@ -39,10 +39,8 @@ keywords: [open source monitoring system, alerting system] - add smtp protocol and support smtp monitoring by @ZY945 - more feature, document and bugfix - ### 尝试部署 - 1. `docker` 环境仅需一条命令即可开始 ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` @@ -58,14 +56,14 @@ keywords: [open source monitoring system, alerting system] ``` docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector ``` + - `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。 - `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 - `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) ----- - +--- ## ⛄ 已支持 > 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! @@ -82,13 +80,12 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 和更多自定义监控模版。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱`。 ----- +--- **Github: https://github.com/apache/hertzbeat** **Gitee: https://gitee.com/hertzbeat/hertzbeat** ----- - +--- ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! @@ -101,7 +98,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN * monitoring the availability of websockets through handshake. by @ZY945 in https://github.com/apache/hertzbeat/pull/1413 * Task-1386 When adding tags in tag management, random colors are given by default. by @prolevel1 in https://github.com/apache/hertzbeat/pull/1412 * add prolevel1 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1415 -* #1397 feature: support for dns monitoring by @Calvin979 in https://github.com/apache/hertzbeat/pull/1416 +* + +# 1397 feature: support for dns monitoring by @Calvin979 in https://github.com/apache/hertzbeat/pull/1416 + * Support monitoring hive metrics by @a-little-fool in https://github.com/apache/hertzbeat/pull/1417 * support legend pageable in history data charts by @tomsun28 in https://github.com/apache/hertzbeat/pull/1414 * update component tip and help tip doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1418 @@ -163,7 +163,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN **Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.3...v1.4.4 ----- +--- ## Supported @@ -179,7 +179,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ---- **Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: https://gitee.com/hertzbeat/hertzbeat** ### **下载链接** @@ -203,8 +203,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - ⬇️ [hertzbeat-collector-macos_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-macos_amd64_1.4.4.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-windows64_1.4.4.zip) - **hertzbeat docker compose script** -- ⬇️ [docker-compose](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) +- ⬇️ [docker-compose](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md index d34f4b4097d..d9b0409be70 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md @@ -12,18 +12,14 @@ keywords: [open source monitoring system, alerting system] HertzBeat 于 2022 年 1 月在 Dromara 开源社区正式开源，经过两年多的社区小伙伴们的不间断项目维护迭代，持续的社区成长，现在，HertzBeat 正式官宣加入 Apache 孵化器！ - ![](/img/blog/apache-incubator-1.png) ![](/img/blog/apache-incubator-2.png) - - 加入 Apache 孵化器不是终点，这是项目的全新起点。加入 Apache 孵化器后，在社区层面，HertzBeat 将积极践行『开放、协作』 的 Apache 之道，持续构建一个公平，多元，包容的开源社区。在开源产品层面，倾听用户声音，提升优化产品使用体验，打造对接开源生态。 非常欢迎各位加入到 HertzBeat 社区，社区接受任何形式的贡献，让我们一起共同推动开源的发展，希望有朝一日 HertzBeat 能像 Apache Kafka, Apache Tomcat 这些基金会顶级项目一样，成为一款世界级的开源产品，我们所贡献的代码被部署运行在全球的各个行业，各个角落。 - ## 什么是 HertzBeat [Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 @@ -38,19 +34,16 @@ HertzBeat 于 2022 年 1 月在 Dromara 开源社区正式开源，经过两年 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 - > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助用户快速搭建自有监控系统。 ## HertzBeat 发展现状 HertzBeat 开源以来主仓库在 GitHub 累计收获 **4.5K+** star, Gitee **2.4K+** star, 累计发布版本 **20** 次，统计的软件安装包 DockerHub 等下载安装量累计超 **100K+** ，社区参与代码贡献人数 **180** 人，项目和社区的不断完善进步, 由衷的感谢每位贡献者的努力和付出💗。 - ## 社区小伙伴们 > 谢谢这些可爱的贡献者们。 -
@@ -281,8 +274,6 @@ HertzBeat 开源以来主仓库在 GitHub 累计收获 **4.5K+** star, Gitee **2
- - ## 特别感谢 感谢所有参与到社区的贡献者。 @@ -304,11 +295,10 @@ HertzBeat 开源以来主仓库在 GitHub 累计收获 **4.5K+** star, Gitee **2 > 感谢导师 @XiaoYu 、 @Yonglun 、 @Justin 、 @Francis 各位导师无私的帮助, 在合规和流程推进上的给予了专业指导。从 Dromara 开源社区到 Apache 孵化器，@XiaoYu 一直是 HertzBeat 的开源领路人。相信未来在各位导师的指导下社区一定社区更加健康的成长。 - ## 来自 Dromara 社区的寄语 > HertzBeat 从 Dromara 明星项目到成为 Apache 孵化器的一员，展现出了强劲的生命力和健康的成长态势。我们为 HertzBeat 的每一步前进感到自豪和振奋。在此，我们向 HertzBeat 团队致以最诚挚的祝贺，也向所有为该项目贡献力量的社区成员表示深深的感激。 - +> > 愿 HertzBeat 在未来的旅程中持续发展，不断创新，成为开源社区中的亮眼之星。我们相信，凭借团队的出色才能和社区的广泛支持，HertzBeat 必将实现更加辉煌的成就，为全球的开发者和用户提供优质的服务和体验。Dromara 将继续全力支持和关注 HertzBeat 的发展，期待它创造出更加精彩的篇章！ --- @@ -329,4 +319,3 @@ HertzBeat 开源以来主仓库在 GitHub 累计收获 **4.5K+** star, Gitee **2 发送任意内容至 dev-subcribe@hertzbeat.apache.org 订阅 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md index 349490ea278..755dae83375 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md @@ -17,8 +17,6 @@ **Gitee: https://gitee.com/hertzbeat/hertzbeat** - - ## 什么是开源之夏？ 开源之夏是由中国科学院软件研究所“开源软件供应链点亮计划”发起并长期支持的一项暑期开源活动，旨在鼓励在 @@ -39,8 +37,6 @@ 各位同学可以自由选择项目，与社区导师沟通实现方案并撰写项目计划书。被选中的学生将在社区导师指导下，按计划完成开发工作，并将成果贡献给社区。社区评估学生的完成度，主办方根据评估结果发放资助金额给学生。 - - ## HertzBeat 课题 ### 1、实现监控模版市场商店 @@ -55,8 +51,6 @@ 这样不仅能让 `HertzBeat` 的生态更加完善，也能让用户的体验变的更好！ - - **要求：** 1. 使用Java17, springboot3编写后端代码，Angular(建议)或Vue编写前端代码。 @@ -64,20 +58,14 @@ 3. 模板页面展示下载量、分类、模板描述信息、模版历史版本(可选)。 4. 实现用户个人页面注册、登录(后期)，上传模板。 - - **产出：** - 1. 特性代码能以PR的形式合入HertzBeat仓库。 - 2. 完成 HertzBeat官方模板市场 - 3. 更新相关帮助文档 - - **联系导师：** 赵青然 [zqr10159@dromara.org](mailto:zqr10159@dromara.org) - - ### 2、实现 Java 原生的 ipmi2 通信协议 **项目难度：进阶/Advanced** @@ -90,8 +78,6 @@ 温度传感器信息和时钟信息。 - - **要求：** 1. 使⽤ Java 基于 UDP 协议实现原⽣的 IPMI2 协议(查询部分),不依赖任何第三⽅包。 @@ -102,8 +88,6 @@ 3. 对查询到的指标信息进⾏抽象和规范化处理,实现配置化管理(可选)。 4. 输出详细的项⽬⽂档,包括设计思路、实现细节、使⽤说明等。 - - **产出：** - 特性代码能以PR的形式合⼊HertzBeat仓库。 @@ -114,12 +98,8 @@ - 完善帮助⽂档。 - - **联系导师：** 铁甲小宝 [tjxiaobao2024@qq.com](mailto:tjxiaobao2024@qq.com) - - ## 参与 HertzBeat 能收获什么？ 有的同学可能会疑惑参与开源之夏能收获到什么呢？ @@ -130,4 +110,4 @@ 4. **【推荐入职/实习】在本次编程之夏项目中表现优秀同学，可推荐入职/实习 你心意的公司工作。** 5. **【额外获得社区惊喜】所有参与本次编程之夏项目的同学，均可有机会成为 Apache HertzBeat 的committer，并拥有属于自己的 apache邮箱。** -**百分百有奖品拿哦**，现在唯一的问题是时间不多了，赶紧上车报名！截止报名时间是6月4日，快点来报名参与 2023 编程之夏吧~ \ No newline at end of file +**百分百有奖品拿哦**，现在唯一的问题是时间不多了，赶紧上车报名！截止报名时间是6月4日，快点来报名参与 2023 编程之夏吧~ 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 e4f668eb5d8..2f612c42c28 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,6 +1,7 @@ # HertzBeat 1.6.0 升级指南 ### 注意：该指南适用于1.5.0向1.6.0版本升级 + ### 如果你使用更老的版本，建议使用导出功能重新安装，或先升级到1.5.0再按本指南升级到1.6.0 ### 二进制安装包升级 @@ -12,6 +13,7 @@ - 当你的服务器中默认环境变量为Java17时，这一步你无需任何操作。 - 当你的服务器中默认环境变量不为Java17时，如Java8、Java11，若你服务器中**没有**其他应用需要低版本Java，根据你的系统，到 [https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) 选择相应的发行版下载，并在搜索引擎搜索如何设置新的环境变量指向新的Java17。 - 当你的服务器中默认环境变量不为Java17时，如Java8、Java11，若你服务器中**有**其他应用需要低版本Java，根据你的系统，到 [https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) 选择相应的发行版下载，并将解压后的文件夹重命名为java，复制到Hertzbeat的解压目录下。 + 2. 升级数据库 打开[https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration)， @@ -24,6 +26,7 @@ - `application.yml`一般需要修改以下部分 默认为： + ```yaml datasource: driver-class-name: org.h2.Driver @@ -42,7 +45,9 @@ logging: level: SEVERE ``` + 如若修改为mysql数据库，给出一个示例： + ```yaml datasource: driver-class-name: com.mysql.cj.jdbc.Driver @@ -63,6 +68,7 @@ ``` - `sureness.yml`修改是可选的，一般在你需要修改账号密码时 + ```yaml # account info config # eg: admin has role [admin,user], password is hertzbeat @@ -87,10 +93,10 @@ account: role: [user] ``` - 4. 添加相应的数据库驱动 - 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动，复制到安装目录下`ext-lib`中。 + 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动，复制到安装目录下`ext-lib`中。 + mysql：[https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.18.zip) oracle（如果你要监控oracle，这两个驱动是必须的） [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) @@ -100,6 +106,7 @@ oracle（如果你要监控oracle，这两个驱动是必须的） ### Docker 方式升级 - Mysql数据库 1. 关闭 HertzBeat 容器 + ``` docker stop hertzbeat ``` @@ -116,6 +123,7 @@ docker stop hertzbeat - `application.yml`一般需要修改以下部分 默认为： + ```yaml datasource: driver-class-name: com.mysql.cj.jdbc.Driver @@ -136,6 +144,7 @@ docker stop hertzbeat ``` - `sureness.yml`修改是可选的，一般在你需要修改账号密码时 + ```yaml # account info config # eg: admin has role [admin,user], password is hertzbeat @@ -162,7 +171,8 @@ account: 4. 添加相应的数据库驱动 - 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + mysql：[https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.18.zip) oracle（如果你要监控oracle，这两个驱动是必须的） [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) @@ -172,6 +182,7 @@ oracle（如果你要监控oracle，这两个驱动是必须的） ### Docker安装升级 - H2内置数据库(生产环境不推荐使用H2) 1. 关闭 HertzBeat 容器 + ``` docker stop hertzbeat ``` @@ -181,9 +192,11 @@ docker stop hertzbeat 前题你已经将 H2 数据库文件 data 目录挂载到本地，或者启动老容器手动将 /opt/hertzbeat/data 目录拷贝出来。 下载 h2 驱动 jar [https://mvnrepository.com/artifact/com.h2database/h2/2.2.220](https://mvnrepository.com/artifact/com.h2database/h2/2.2.220) 使用 h2 驱动 jar 本地启动数据库 + ``` java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 ``` + 打开[https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration)， 选择你使用的数据库的目录下相应的 `V160__update_column.sql`文件在 H2 执行升级sql。 @@ -194,6 +207,7 @@ java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 - `application.yml`一般需要修改以下部分 默认为： + ```yaml datasource: driver-class-name: org.h2.Driver @@ -214,6 +228,7 @@ java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 ``` - `sureness.yml`修改是可选的，一般在你需要修改账号密码时 + ```yaml # account info config # eg: admin has role [admin,user], password is hertzbeat @@ -238,10 +253,10 @@ account: role: [user] ``` - 4. 添加相应的数据库驱动 - 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + mysql：[https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.18.zip) oracle（如果你要监控oracle，这两个驱动是必须的） [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) @@ -249,8 +264,8 @@ oracle（如果你要监控oracle，这两个驱动是必须的） 接下来，像之前那样 Docker 运行启动，即可体验最新的HertzBeat1.6.0！ ### 通过导出导入升级 -> 若不想如上繁琐的脚本升级方式，可以直接将老环境的监控任务和阈值信息导出导入 +> 若不想如上繁琐的脚本升级方式，可以直接将老环境的监控任务和阈值信息导出导入 1. 部署一套最新版本的新环境 2. 在页面上将老环境的监控任务和阈值信息导出。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md index 41267f8f964..e0f982e0e7a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md @@ -13,7 +13,7 @@ keywords: [open source, monitoring, alerting] 经过近五个月的社区开发迭代贡献和两个月的Apache Incubator孵化过程，Apache HertzBeat (incubating) v1.6.0 终于出来了。 这个版本我们增加了对OpenAi监控，Redfish协议服务器，插件机制，支持了NebulaGraph, Apache Yarn, HDFS, Hbase, Storm等更多功能特性。 由于License兼容问题，我们在底层替换了ORM框架，计算框架等多个依赖，Hibernate -> EclipseLink, 这也算是JPA生态下为数不多的迁移踩坑实践。 -同时修复了一些bug和优化了一些功能，更完善的文档。欢迎大家尝试使用，提出宝贵意见和建议，共同推动HertzBeat的发展。🎉 +同时修复了一些bug和优化了一些功能，更完善的文档。欢迎大家尝试使用，提出宝贵意见和建议，共同推动HertzBeat的发展。🎉 **当然，最重要的是给在社区的贡献者们致以最好的感谢！** @@ -35,7 +35,6 @@ keywords: [open source, monitoring, alerting] - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 - > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助用户快速搭建自有监控系统。 ![hertzBeat](/img/docs/hertzbeat-arch.png) @@ -367,7 +366,6 @@ keywords: [open source, monitoring, alerting] * @lw-yang made their first contribution in https://github.com/apache/hertzbeat/pull/2047 * @xfl12345 made their first contribution in https://github.com/apache/hertzbeat/pull/2048 - ## 一条命令即可开始 ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` @@ -376,12 +374,9 @@ keywords: [open source, monitoring, alerting] ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` - 详细参考 HertzBeat 官网文档 https://hertzbeat.com/docs - ----- - +--- **Github: https://github.com/apache/hertzbeat** 下载页面: https://hertzbeat.apache.org/docs/download/ @@ -390,7 +385,7 @@ keywords: [open source, monitoring, alerting] Have Fun! ----- +--- HertzBeat, Make Monitoring Easier! diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md index 3cd89bc0ac2..dd19af388f2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md @@ -8,7 +8,6 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) > 🎉非常高兴成为 Apache HertzBeat 项目的 Committer，受社区邀请来做一个自我介绍🥰。 @@ -43,6 +42,3 @@ keywords: [open source monitoring system, alerting system] 最后要感谢社区的 logicz 邀请我成为 Committer，tom 对我 PR 的 review，预祝 HertzBeat 从孵化器毕业成为明星项目🎊。 - - - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-08-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-08-new-committer.md index 9cefa3dc661..a045e67963a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-08-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-08-new-committer.md @@ -8,10 +8,8 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) - ### 初识 Apache Hertzbeat 我第一次接触 Apache Hertzbeat 项目是因为一个偶然的机会。当时，我正在寻找一个开源项目来监控我们公司相关服务。Apache Hertzbeat 作为一个通用监控的项目，自然进入了我的视野。我开始通过阅读官方文档和浏览项目的代码库，来了解它的架构和功能。 @@ -24,7 +22,6 @@ keywords: [open source monitoring system, alerting system] 随着对项目的理解加深，我开始挑战一些更复杂的问题。我阅读了大量的代码，参与了社区的日常讨论，月例会讨论，并在issue/pr中活跃发言。这些活动不仅帮助我提升了技术能力，还让我对项目的发展方向有了更好的把握。我开始提出自己的想法和建议，积极参与设计讨论，并提出了一些新的功能。 - ### 被提名为 Committer 在经过一段时间的积极贡献之后，我收到了来自社区(tom) 的Committer 的提名。成为 Committer 意味着我将拥有更大的责任和权限。提名过程是公开和透明的，社区的每一个成员都有机会表达他们的意见。 @@ -49,4 +46,4 @@ keywords: [open source monitoring system, alerting system] ### 结语 -成为 Apache Hertzbeat 项目的 Committer 是一个充满挑战和收获的旅程。通过不断的学习和贡献，我不仅提升了自己的技术能力，也在社区中找到了归属感和成就感。我希望我的经历能够激励更多的人参与到开源社区中来，共同推动技术的进步和发展。借用tom老哥的话：参与开源不要影响大家的工作和生活，那就违背初衷啦，大家利用下班后空闲时间参与哦。 \ No newline at end of file +成为 Apache Hertzbeat 项目的 Committer 是一个充满挑战和收获的旅程。通过不断的学习和贡献，我不仅提升了自己的技术能力，也在社区中找到了归属感和成就感。我希望我的经历能够激励更多的人参与到开源社区中来，共同推动技术的进步和发展。借用tom老哥的话：参与开源不要影响大家的工作和生活，那就违背初衷啦，大家利用下班后空闲时间参与哦。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-15-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-15-new-committer.md index 2cba35df2ce..1942ccf08d7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-15-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-15-new-committer.md @@ -8,12 +8,10 @@ tags: [opensource, practice] keywords: [open source monitoring system, alerting system] --- - ![hertzBeat](/img/blog/new-committer.png) 大家好，非常荣幸可以收到社区邀请被提名为 Apache HertzBeat 的 Committer。我先做一个简单的自我介绍，从2019年工作开始，一直从事后端开发工作，主要使用Java语言，目前在一家网络安全公司从事网络安全相关产品后端开发工作。 - ### 遇见 我工作的项目里部署着数台物理服务器，其中运行着各种数据库，中间件，尽管部署了 Prometheus + grafana 的监控组合，但由于大多数的服务和服务器都需要额外安装 exporter，这套监控系统并没有覆盖到项目的全部，有时候服务宕机了，被用到了才发现。四月份的某一天我刷到了一篇公众号文章介绍了 HertzBeat，我马上被不需要 agent，全程可视化配置的特新吸引加上支持docker一键部署，我迅速的部署起来了 HertzBeat 并投入了使用。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-27-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-27-new-committer.md index 562ecc8eee7..05a5d5329ce 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-27-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-27-new-committer.md @@ -36,4 +36,4 @@ keywords: [open source monitoring system, alerting system] ## 结语 -成为Apache Hertzbeat的Committer于我而言是一次很有趣的经历，无时无刻都在激励着我。今后我也会持续对Apache Hertzbeat社区贡献下去，也希望Apache Hertzbeat能顺利从孵化器毕业。 \ No newline at end of file +成为Apache Hertzbeat的Committer于我而言是一次很有趣的经历，无时无刻都在激励着我。今后我也会持续对Apache Hertzbeat社区贡献下去，也希望Apache Hertzbeat能顺利从孵化器毕业。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md index be6c1adf2fb..ad575b95474 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md @@ -11,11 +11,13 @@ keywords: [open source monitoring system, alerting system] ![hertzBeat](/img/blog/new-committer.png) > 非常荣幸能成为Apache Hertzbeat的Committer -## 个人介绍 +> + ## 个人介绍 本人是2023年毕业，目前在一家互联网公司担任java开发工程师。 ## 初识 Apache Hertzbeat + 毕业之后，工作了半年，萌生出接触开源的想法。然而，在 GitHub 上搜索开源项目时，发现诸多社区活跃度欠佳，官方文档也不完善，致使项目上手难度颇大，因此开源之事暂且搁置。 某天，在某平台看到小宝大佬的一个帖子，我瞬间兴趣盎然，随即私聊小宝，咨询开源相关事宜。小宝大佬极其热情且细致地为我讲解了不少开源方面的情况，并向我推荐了 Hertzbeat 这个项目。 @@ -34,4 +36,4 @@ keywords: [open source monitoring system, alerting system] ## 结语 -成为Apache Hertzbeat的Committer于我而言是很有意义对事情，今后我也会持续对Apache Hertzbeat社区贡献下去，也希望Apache Hertzbeat能顺利从孵化器毕业，希望社区越来越好。 \ No newline at end of file +成为Apache Hertzbeat的Committer于我而言是很有意义对事情，今后我也会持续对Apache Hertzbeat社区贡献下去，也希望Apache Hertzbeat能顺利从孵化器毕业，希望社区越来越好。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-29-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-29-new-committer.md index 506725aaac6..5292ceefc37 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-29-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-29-new-committer.md @@ -10,25 +10,30 @@ keywords: [open source monitoring system, alerting system] ![hertzBeat](/img/blog/new-committer.png) -> 非常荣幸能成为Apache Hertzbeat的Committer +> 非常荣幸能成为Apache Hertzbeat的Committer ## 成为更强大团队的一份子：我的贡献与成长 + 在开源社区中，每一次的贡献不仅是对项目的推动，也是个人成长的见证。近期，在Apache HertzBeat项目中，我通过一系列的优化与功能增强，不仅为项目的发展贡献了力量，也实现了自我技能的提升。今天，我想借此机会分享我的贡献经历与成长感悟。 ## 从细节入手，优化视觉与交互 + 我始终认为细节决定成败，在参与项目之初，我便从界面优化入手，致力于提升用户的视觉和交互体验。我优化了监控选择菜单的模态窗口布局，使其更加符合用户的操作习惯；调整了监控详情页面的头部样式和内容布局，使得信息展示更加清晰直观。同时，我还统一了组件的边框圆角值，解决了国际化翻译缺失等问题，确保了系统界面的一致性和完整性。 这些看似微小的改动，实则大大提升了系统的整体美观度和用户体验。通过这个过程，我深刻体会到界面设计对于用户体验的重要性，也锻炼了自己在细节处理上的能力。 ## 深入功能模块，实现功能增强 + 除了界面优化外，我还积极参与了功能模块的扩展与增强工作。我重构了系统中的重复代码，抽象出了通用组件，提高了代码的复用性和可维护性。这些改进不仅简化了开发流程，还降低了后期维护的成本。同时，我还为多功能输入组件添加了密码类型支持和搜索类型支持，进一步丰富了组件的功能和用途。 在功能实现的过程中，我遇到了不少挑战。但正是这些挑战促使我不断学习和探索新的技术和方法。通过查阅官方文档等方式，我逐步攻克了难关，并成功完成了任务。这个过程不仅提升了我的技术能力，也让我更加深刻地理解了团队协作的重要性。 ## 注重用户反馈，持续优化产品 + 我始终认为用户是产品的最终评判者。因此，我在公司内部以及社区持续收集和分析用户的反馈意见，并根据这些意见进行针对性的优化和改进。通过优化搜索与筛选功能、统一使用简洁的交互元素等方式，我不断提升了用户的使用体验。 这个过程中，我深刻体会到了用户导向的重要性。只有真正关注用户的需求和期望才能打造出符合市场需求的产品。 ## 展望未来，持续贡献与成长 + 回顾过去一段时间的贡献经历我深感自豪和满足。但同时我也清楚地认识到自己还有很多不足之处需要不断学习和提升。未来我将继续秉持着严谨、创新、用户至上的精神不断探索和实践为Apache HertzBeat项目贡献更多的力量。同时我也期待与更多的团队成员一起共同成长和进步共同推动项目的繁荣发展。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md index 5f8db64d1be..e734c1536a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md @@ -3,14 +3,17 @@ id: extend-http-default title: HTTP协议系统默认解析方式 sidebar_label: 系统默认解析方式 --- -> HTTP接口调用获取响应数据后，用 Apache HertzBeat (incubating) 默认的解析方式去解析响应数据。 -**此需接口响应数据结构符合HertzBeat指定的数据结构规则** +> HTTP接口调用获取响应数据后，用 Apache HertzBeat (incubating) 默认的解析方式去解析响应数据。 -### HertzBeat数据格式规范 -注意⚠️ 响应数据为JSON +**此需接口响应数据结构符合HertzBeat指定的数据结构规则** + +### HertzBeat数据格式规范 + +注意⚠️ 响应数据为JSON 单层格式：key-value + ```json { "metricName1": "metricValue", @@ -19,7 +22,9 @@ sidebar_label: 系统默认解析方式 "metricName4": "metricValue" } ``` + 多层格式：数组里面套key-value + ```json [ { @@ -36,9 +41,11 @@ sidebar_label: 系统默认解析方式 } ] ``` + 样例： 查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 -若只有一台虚拟机，其单层格式为: +若只有一台虚拟机，其单层格式为: + ```json { "hostname": "linux-1", @@ -48,7 +55,9 @@ sidebar_label: 系统默认解析方式 "runningTime": 100 } ``` -若有多台虚拟机，其多层格式为: + +若有多台虚拟机，其多层格式为: + ```json [ { @@ -75,7 +84,7 @@ sidebar_label: 系统默认解析方式 ] ``` -**对应的监控模版YML可以配置为如下** +**对应的监控模版YML可以配置为如下** ```yaml category: custom @@ -274,3 +283,4 @@ metrics: parseType: jsonPath parseScript: '$' ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md index 357cbd133ca..fcd44c5bbf3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md @@ -1,19 +1,17 @@ --- id: extend-http-example-hertzbeat title: 教程一:适配一款基于HTTP协议的监控类型 -sidebar_label: 教程一:适配一款HTTP协议监控 +sidebar_label: 教程一:适配一款HTTP协议监控 --- -通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 监控系统下新增适配一款基于http协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 监控系统下新增适配一款基于http协议的监控类型。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 ### HTTP协议解析通用响应结构体，获取指标数据 > 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - ``` { "code": 200, @@ -22,6 +20,7 @@ sidebar_label: 教程一:适配一款HTTP协议监控 } ``` + 如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API `http://localhost:1157/api/summary`, 其响应数据为: @@ -58,7 +57,6 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - ### 新增自定义监控模版YML **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -190,32 +188,24 @@ metrics: **新增完毕，现在我们重启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!!! - ---- #### 完！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md index b7a665a60b9..fc87145178a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md @@ -6,15 +6,15 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 通过此教程我们一步一步描述如何在教程一的基础上改造，新增一个监控指标，先调用认证接口获取TOKEN后，使用TOKEN作为参数供后面的监控指标采集认证使用。 -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 -### 请求流程 +### 请求流程 -【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 +【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 > 这里我们依然用教程一的hertzbeat监控举例！hertzbeat后台接口不仅仅支持教程一使用的basic直接账户密码认证，也支持token认证。 -**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: +**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: ```json { @@ -22,7 +22,8 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 "identifier": "admin" } ``` -**响应结构数据如下**: + +**响应结构数据如下**: ```json { @@ -104,9 +105,9 @@ params: required: false ``` -### 定义监控指标`auth`登录请求获取`token` +### 定义监控指标`auth`登录请求获取`token` -1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. +1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. ```yaml @@ -222,16 +223,13 @@ metrics: ![](/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`作为变量参数给后面的监控指标采集使用 +### 将`token`作为变量参数给后面的监控指标采集使用 **在`app-hertzbeat_token.yml`新增一个监控指标定义 `summary` 同教程一中的`summary`相同, 设置采集优先级为1** **设置此监控指标的HTTP协议配置中认证方式为 `Bearer Token` 将上一个监控指标`auth`采集的指标`token`作为参数给其赋值，使用`^o^`作为内部替换符标识，即`^o^token^o^`。如下:** @@ -247,7 +245,7 @@ metrics: bearerTokenToken: ^o^token^o^ ``` -**最终`app-hertzbeat_token.yml`定义如下:** +**最终`app-hertzbeat_token.yml`定义如下:** ```yaml @@ -381,9 +379,9 @@ metrics: ``` -**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** +**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** -![](/img/docs/advanced/extend-http-example-8.png) +![](/img/docs/advanced/extend-http-example-8.png) ![](/img/docs/advanced/extend-http-example-9.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md index fef3c3d2fa8..1439c532219 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md @@ -3,16 +3,18 @@ id: extend-http-jsonpath title: HTTP协议JsonPath解析方式 sidebar_label: JsonPath解析方式 --- + > HTTP接口调用获取响应数据后，用JsonPath脚本解析的解析方式去解析响应数据。 注意⚠️ 响应数据为JSON格式 -**使用JsonPath脚本将响应数据解析成符合 Apache HertzBeat (incubating) 指定的数据结构规则的数据** +**使用JsonPath脚本将响应数据解析成符合 Apache HertzBeat (incubating) 指定的数据结构规则的数据** + +#### JsonPath操作符 -#### JsonPath操作符 -[JSONPath在线验证](https://www.jsonpath.cn) +[JSONPath在线验证](https://www.jsonpath.cn) -| JSONPATH | 帮助描述 | +| JSONPATH | 帮助描述 | |------------------|-----------------------------------| | $ | 根对象或元素 | | @ | 当前对象或元素 | @@ -25,8 +27,10 @@ sidebar_label: JsonPath解析方式 | ?() | 过滤器（脚本）表达式. | | () | 脚本表达式. | -#### HertzBeat数据格式规范 +#### HertzBeat数据格式规范 + 单层格式：key-value + ```json { "metricName1": "metricValue", @@ -35,7 +39,9 @@ sidebar_label: JsonPath解析方式 "metricName4": "metricValue" } ``` + 多层格式：数组里面套key-value + ```json [ { @@ -53,10 +59,11 @@ sidebar_label: JsonPath解析方式 ] ``` -#### 样例 +#### 样例 查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 -接口返回的原始数据如下： +接口返回的原始数据如下： + ```json { "firstName": "John", @@ -80,7 +87,8 @@ sidebar_label: JsonPath解析方式 } ``` -我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： +我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： + ```json [ { @@ -93,9 +101,10 @@ sidebar_label: JsonPath解析方式 } ] ``` -此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 -**对应的监控模版YML可以配置为如下** +此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 + +**对应的监控模版YML可以配置为如下** ```yaml category: custom @@ -165,3 +174,4 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md index 9a0dca41ae3..35a8f4fa5f5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md @@ -1,21 +1,22 @@ --- id: extend-http title: HTTP协议自定义监控 -sidebar_label: HTTP协议自定义监控 +sidebar_label: HTTP协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 -### HTTP协议采集流程 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 + +### HTTP协议采集流程 + 【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 -HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 +HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 **系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) -**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) - +**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -23,15 +24,14 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ------- -下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 +下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 -### 监控模版YML +### 监控模版YML > 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 -样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 - +样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -277,3 +277,4 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md index 6ff4b9bbed1..bb946d8ce1c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md @@ -1,29 +1,34 @@ --- id: extend-jdbc title: JDBC协议自定义监控 -sidebar_label: JDBC协议自定义监控 +sidebar_label: JDBC协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 -> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 -### JDBC协议采集流程 -【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 +> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 + +### JDBC协议采集流程 + +【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 由流程可见，我们自定义一个JDBC协议的监控类型，需要配置JDBC请求参数，配置获取哪些指标，配置查询SQL语句。 -### 数据解析方式 +### 数据解析方式 + SQL查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有三种：oneRow, multiRow, columns -#### **oneRow** -> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 +#### **oneRow** + +> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book limit 1; -这里指标字段就能和响应数据一一映射为一行采集数据。 +这里指标字段就能和响应数据一一映射为一行采集数据。 #### **multiRow** -> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 + +> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 例如： 查询的指标字段为：one tow three four @@ -31,33 +36,34 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 这里指标字段就能和响应数据一一映射为多行采集数据。 #### **columns** -> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 + +> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 例如： 查询字段：one tow three four 查询SQL：select key, value from book; -SQL响应数据： +SQL响应数据： -| key | value | -|----------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +| key | value | +|-------|-------| +| one | 243 | +| two | 435 | +| three | 332 | +| four | 643 | -这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 +这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) - ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 -### 监控模版YML +下面详细介绍下文件的配置用法，请注意看使用注释。 + +### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 @@ -237,3 +243,4 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md index cca1bcfb726..71bb06ba2b2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md @@ -1,38 +1,38 @@ --- id: extend-jmx title: JMX协议自定义监控 -sidebar_label: JMX协议自定义监控 +sidebar_label: JMX协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 -> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 +> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 + +### JMX协议采集流程 -### JMX协议采集流程 -【**对端JAVA应用暴露JMX服务**】->【**HertzBeat直连对端JMX服务**】->【**获取配置的 Mbean Object 数据**】->【**指标数据提取**】 +【**对端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协议采集指标数据。 - +样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -236,3 +236,4 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md index b5685eb3b16..34514b3f2bb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md @@ -20,11 +20,11 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 > `filterName`: 过滤属性名称（可选） > `filterValue`: 过滤属性值（可选） -例如： +例如： - online_meta_count#SHOW HOSTS META#Status#ONLINE - 对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 +对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 - online_meta_count#SHOW HOSTS META## - 统计 `SHOW HOSTS META` 返回的行数 +统计 `SHOW HOSTS META` 返回的行数 #### **oneRow** @@ -72,6 +72,7 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 ![](/img/docs/advanced/extend-point-1.png) ------- + 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML @@ -169,3 +170,4 @@ metrics: - match (v:tag2) return "tag2" as name ,count(v) as cnt timeout: ^_^timeout^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md index d2b0ee36cdc..6de319a1c15 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md @@ -1,12 +1,13 @@ --- id: extend-point title: 自定义监控 -sidebar_label: 自定义监控 +sidebar_label: 自定义监控 --- + > HertzBeat拥有自定义监控能力，您只需配置监控模版YML就能适配一款自定义的监控类型。 -> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 +> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 -### 自定义流程 +### 自定义流程 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -14,13 +15,13 @@ sidebar_label: 自定义监控 ------- -### 监控模版YML +### 监控模版YML **HertzBeat的设计是一个监控模版对应一个监控类型，所有监控类型都是由监控模版来定义的**。 -> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 +> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 -下面使用样例详细介绍下这监控模版YML的配置用法。 +下面使用样例详细介绍下这监控模版YML的配置用法。 样例：自定义一个 `app` 名称为 `example2` 的自定义监控类型，其使用HTTP协议采集指标数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md index 3ff65d60a17..387d67c5987 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md @@ -1,38 +1,38 @@ --- id: extend-snmp title: SNMP协议自定义监控 -sidebar_label: SNMP协议自定义监控 +sidebar_label: SNMP协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 -> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 +> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 + +### SNMP协议采集流程 -### SNMP协议采集流程 -【**对端开启SNMP服务**】->【**HertzBeat直连对端SNMP服务**】->【**根据配置抓取对端OID指标信息**】->【**指标数据提取**】 +【**对端开启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 协议采集指标数据。 - +样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring @@ -207,3 +207,4 @@ metrics: processes: 1.3.6.1.2.1.25.1.6.0 location: 1.3.6.1.2.1.1.6.0 ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md index 8284726e661..0f643f153f8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md @@ -1,21 +1,25 @@ --- id: extend-ssh title: SSH协议自定义监控 -sidebar_label: SSH协议自定义监控 +sidebar_label: SSH协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 -> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 +> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 + +### SSH协议采集流程 -### SSH协议采集流程 -【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 +【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 由流程可见，我们自定义一个SSH协议的监控类型，需要配置SSH请求参数，配置获取哪些指标，配置查询脚本语句。 -### 数据解析方式 +### 数据解析方式 + SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有两种：oneRow, multiRow，能满足绝大部分指标需求。 -#### **oneRow** -> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 +#### **oneRow** + +> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 例如： 需要查询Linux的指标 hostname-主机名称，uptime-启动时间 @@ -23,31 +27,37 @@ SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获 启动时间原始查询命令：`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` +uptime值为 `14:00:15 up 72 days` -这里指标字段就能和响应数据一一映射为一行采集数据。 +这里指标字段就能和响应数据一一映射为一行采集数据。 #### **multiRow** -> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 + +> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 例如： 查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 -内存指标原始查询命令为：`free -m`, 控制台响应： +内存指标原始查询命令为：`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 @@ -55,22 +65,22 @@ total used free buff_cache available 这里指标字段就能和响应数据一一映射为采集数据。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 + +下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 -样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 - +样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -206,3 +216,4 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md index 14643c29c4e..4d2e2425257 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md @@ -1,28 +1,31 @@ --- id: extend-telnet title: Telnet协议自定义监控 -sidebar_label: Telnet协议自定义监控 +sidebar_label: Telnet协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用Telnet协议自定义指标监控。 -> 使用 Telnet 协议自定义监控可以让我们通过编写 Telnet 命令脚本来监控和采集我们想要监控的 Linux 指标 +> 使用 Telnet 协议自定义监控可以让我们通过编写 Telnet 命令脚本来监控和采集我们想要监控的 Linux 指标 + +### Telnet协议采集流程 -### Telnet协议采集流程 -【**系统直连Linux**】->【**运行TELNET命令脚本语句**】->【**响应数据解析**】->【**指标数据提取**】 +【**系统直连Linux**】->【**运行TELNET命令脚本语句**】->【**响应数据解析**】->【**指标数据提取**】 由流程可见，我们自定义一个Telnet协议的监控类型，需要配置Telnet请求参数，配置获取哪些指标，配置查询脚本语句。 -### 数据解析方式 -通过配置监控模版YML的指标field, aliasFields, telnet 协议下的获取数据映射。 +### 数据解析方式 +通过配置监控模版YML的指标field, aliasFields, telnet 协议下的获取数据映射。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 + +下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML @@ -294,3 +297,4 @@ metrics: ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md index 22578d67854..7b3112f52f8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md @@ -4,16 +4,14 @@ title: 自定义适配一款基于HTTP协议的新监控类型 sidebar_label: 教程案例 --- -通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 系统下自定义新增适配一款基于 http 协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 系统下自定义新增适配一款基于 http 协议的监控类型。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 ### HTTP协议解析通用响应结构体，获取指标数据 > 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - ``` { "code": 200, @@ -22,6 +20,7 @@ sidebar_label: 教程案例 } ``` + 如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API `http://localhost:1157/api/summary`, 其响应数据为: @@ -58,12 +57,11 @@ sidebar_label: 教程案例 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - ### 新增配置监控模版YML **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 +定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 定义采集类型是啥，需要用哪种协议采集方式，采集的指标是啥，协议的配置参数等。我们直接复用 `api`监控模版 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可，如下：注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 @@ -229,32 +227,24 @@ metrics: **点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`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!!! - ---- #### 完！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md index c91cdca7171..c30a850a3c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md @@ -5,23 +5,22 @@ sidebar_position: 2 --- - ## 成为 Apache HertzBeat™ 的 Committer 任何支持社区并在 CoPDoC 领域中工作的人都可以成为 Apache HertzBeat 的 Committer。CoPDoC 是 ASF 的缩写，用来描述我们如何不仅仅通过代码来认识到您的贡献。 @@ -58,3 +57,4 @@ Committer 的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - 对于拉取请求审查保持积极、有礼貌与尊重。 - 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 - 通过撰写文章或举办活动来推广项目。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md index e64661b7595..39cf1da9123 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md @@ -5,20 +5,20 @@ sidebar_position: 3 --- ## 成为 Apache HertzBeat™ 的 PMC 成员 @@ -45,6 +45,7 @@ PMC 成员的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - +3 个月的高度活动和参与。 ### 贡献的质量 + - 对项目有深入的理解。 - 经过充分测试、良好设计、遵循 Apache HertzBeat 的编码标准，及简单的修复补丁。 - 井井有条的面向用户的详细文档。 @@ -56,3 +57,4 @@ PMC 成员的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - 对于拉取请求审查保持积极、有礼貌与尊重。 - 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 - 通过撰写文章或举办活动来推广项目。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md index a9a6f54d474..1cad8c3add1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md @@ -5,41 +5,38 @@ sidebar_position: 3 --- - ## 1 拉取请求与变更规则 1. `ISSUE`/`PR`(拉取请求) 的引导和命名 - - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) + - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) - - 标题命名格式(英文，小写) - `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + - 标题命名格式(英文，小写) + `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` 2. 添加描述信息 - - 新建 `PR` 时请仔细描述此贡献，描述文档和代码同样重要。审阅者可以从描述中，而不仅仅是从代码中，了解问题和解决方案。 - - 勾选是否完成了对应的 Checklist。 - + - 新建 `PR` 时请仔细描述此贡献，描述文档和代码同样重要。审阅者可以从描述中，而不仅仅是从代码中，了解问题和解决方案。 + - 勾选是否完成了对应的 Checklist。 3. 建议一次 `PR` 只包含一个功能/一种修复/一类改进/一种重构/一次清理/一类文档等 - 4. 提交消息(英文，小写，无特殊字符) - 消息的提交应遵循与 `PR` 类似的模式：`[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + 消息的提交应遵循与 `PR` 类似的模式：`[feature/bugfix/doc/improve/refactor/bug/cleanup] title` ## 2 代码检查样式 @@ -69,81 +66,79 @@ sidebar_position: 3 ### 3.1 命名风格 1. 优先为变量命名选择名词，这样更容易区分`变量`或`方法`。 + ```java - Cache publicKeyCache; + Cache publicKeyCache; ``` - 2. 变量的拼音缩写是禁止的（排除地名等名词），例如chengdu。 - 3. 推荐的变量名以 `类型` 结尾。 对于 `Collection/List` 类型的变量，取 `xxxx` （复数表示多个元素）或以 `xxxList` （特定类型）结束。 对于 `map` 类型的变量，清晰地描述 `key` 和 `value`： + ```java - Map idUserMap; - Map userIdNameMap; + Map idUserMap; + Map userIdNameMap; ``` - 4. 通过其名称直观地知道变量的类型和含义。 方法名称应首先以动词开始，如下所示： + ```java - void computeVcores(Object parameter1); + void computeVcores(Object parameter1); ``` - > 注意：在 `Builder` 工具类中不必严格遵循这项规则。 - + > 注意：在 `Builder` 工具类中不必严格遵循这项规则。 ### 3.2 常量变量定义 1. 多余的字符串应提取为常量 - >如果一个常量被硬编码两次或多次，请直接提取它为常量并更改相应的引用。 - 通常，`log` 中的常量可以忽略提取。 - - - 负面示例： - - ```java - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put("status", "success"); - resp.put("code", ResponseCode.CODE_SUCCESS); - resp.put("data", data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put("status", "error"); - resp.put("code", ResponseCode.CODE_FAIL); - resp.put("data", null); - return resp; - } - ``` - - - 正面示例： - - > 字符串提取为常量引用。 - - ```java - public static final String STATUS = "status"; - public static final String CODE = "code"; - public static final String DATA = "data"; - - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "success"); - resp.put(CODE, ResponseCode.CODE_SUCCESS); - resp.put(DATA, data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "error"); - resp.put(CODE, ResponseCode.CODE_FAIL); - resp.put(DATA, null); - return resp; - } - ``` + > 如果一个常量被硬编码两次或多次，请直接提取它为常量并更改相应的引用。 + > 通常，`log` 中的常量可以忽略提取。 + + - 负面示例： + + ```java + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put("status", "success"); + resp.put("code", ResponseCode.CODE_SUCCESS); + resp.put("data", data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put("status", "error"); + resp.put("code", ResponseCode.CODE_FAIL); + resp.put("data", null); + return resp; + } + ``` + - 正面示例： + + > 字符串提取为常量引用。 + + ```java + public static final String STATUS = "status"; + public static final String CODE = "code"; + public static final String DATA = "data"; + + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "success"); + resp.put(CODE, ResponseCode.CODE_SUCCESS); + resp.put(DATA, data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "error"); + resp.put(CODE, ResponseCode.CODE_FAIL); + resp.put(DATA, null); + return resp; + } + ``` 2. 确保代码的可读性和直观性 - `annotation` 符号中的字符串不需要提取为常量。 @@ -155,9 +150,9 @@ sidebar_position: 3 4. 关于 `constant/variable` 行的排序顺序 按以下顺序对类中的变量行进行排序： - 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` - 2. `public static v`, `static v`,`protected static v`, `private static v` - 3. `public v`, `v`, `protected v`, `private v` + 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` + 2. `public static v`, `static v`,`protected static v`, `private static v` + 3. `public v`, `v`, `protected v`, `private v` ### 3.3 方法规则 @@ -174,32 +169,28 @@ sidebar_position: 3 3. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。 一般来说，需要坚持以下原则： - - 便于测试 - - 有好的语义 - - 易于阅读 + - 便于测试 + - 有好的语义 + - 易于阅读 此外，还需要考虑在组件、逻辑、抽象和场景等方面的切割是否合理。 > 然而，目前还没有明确的演示定义。在演变过程中，我们将为开发者提供更多的示例，以便他们有更清晰的参考和理解。 - ### 3.4 集合规则 1. 对于返回的 `collection` 值，除非有特殊的 `concurrent` (如线程安全)，总是返回 `interface`，例如： - - - 如果使用 `ArrayList`，则返回 List - - 如果使用 `HashMap`，则返回 Map - - 如果使用 `HashSet`，则返回 Set - + - 如果使用 `ArrayList`，则返回 List + - 如果使用 `HashMap`，则返回 Map + - 如果使用 `HashSet`，则返回 Set 2. 如果存在多线程，可以使用以下声明或返回类型： - ```java - private CurrentHashMap map; - public CurrentHashMap funName(); - ``` +```java +private CurrentHashMap map; +public CurrentHashMap funName(); +``` 3. 使用 `isEmpty()` 而不是 `length() == 0` 或者 `size() == 0` - - 负面示例： ```java @@ -207,7 +198,6 @@ sidebar_position: 3 return; } ``` - - 正面示例： ```java @@ -227,9 +217,8 @@ sidebar_position: 3 ### 3.6 控制/条件语句 1. 避免因不合理的 `条件/控制` 分支顺序导致： - - - 多个代码行的 `深度` 为 `n+1` - - 多余的行 + - 多个代码行的 `深度` 为 `n+1` + - 多余的行 一般来说，如果一个方法的代码行深度由于连续嵌套的 `if... else..` 超过了 `2+ Tabs`，那么应该考虑试图 - `合并分支`， @@ -238,77 +227,85 @@ sidebar_position: 3 以减少代码行深度并提高可读性，例如： - 联合或将逻辑合并到下一级调用中 - - 负面示例： - ```java - if (isInsert) { - save(platform); - } else { - updateById(platform); - } - ``` - - 正面示例： - ```java - saveOrUpdate(platform); - ``` +- 负面示例： + +```java +if (isInsert) { +save(platform); +} else { +updateById(platform); +} +``` + +- 正面示例： + +```java +saveOrUpdate(platform); +``` + - 合并条件 - - 负面示例： - ```java - if (expression1) { - if(expression2) { - ...... - } - } - ``` - - 正面示例： - ```java - if (expression1 && expression2) { - ...... - } - ``` +- 负面示例： + +```java +if (expression1) { +if(expression2) { +...... +} +} + +``` + +- 正面示例： + + ```java + if (expression1 && expression2) { + ...... + } + ``` - 反转条件 - - 负面示例： - - ```java - public void doSomething() { - // 忽略更深的代码块行 - // ..... - if (condition1) { - ... - } else { - ... - } - } - ``` - - - 正面示例： - - ```java - public void doSomething() { - // 忽略更深的代码块行 - // ..... - if (!condition1) { - ... - return; - } - // ... - } - ``` +- 负面示例： + + ```java + public void doSomething() { + // 忽略更深的代码块行 + // ..... + if (condition1) { + ... + } else { + ... + } + } + ``` +- 正面示例： + + ```java + public void doSomething() { + // 忽略更深的代码块行 + // ..... + if (!condition1) { + ... + return; + } + // ... + } + ``` - 使用单一变量或方法减少复杂的条件表达式 - - 负面示例： - ```java - if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { - ... - } - ``` - - - 正面示例： - ```java - if (containsSqlServer(dbType)) { - .... - } - //..... - // containsSqlServer的定义 - ``` +- 负面示例： + + ```java + if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { + ... + } + ``` +- 正面示例： + + ```java + if (containsSqlServer(dbType)) { + .... + } + //..... + // containsSqlServer的定义 + ``` > 在未来，使用 `sonarlint` 和 `better highlights` 检查代码深度看起来是个不错的选择。 @@ -316,20 +313,20 @@ sidebar_position: 3 1. 方法缺少注释： - - `When`：该方法何时可以被调用 - - `How`：如何使用此方法以及如何传递参数等 - - `What`：此方法实现了哪些功能 - - `Note`：在调用此方法时开发人员应注意什么 +- `When`：该方法何时可以被调用 +- `How`：如何使用此方法以及如何传递参数等 +- `What`：此方法实现了哪些功能 +- `Note`：在调用此方法时开发人员应注意什么 2. 缺少必要的类头部描述注释。 - 添加 `What`，`Note` 等，如上述 `1` 中提到的。 +添加 `What`，`Note` 等，如上述 `1` 中提到的。 3. 在接口中的方法声明必须被注释。 - - 如果实现的语义和接口声明的注释内容不一致，则具体的实现方法也需要用注释重写。 +- 如果实现的语义和接口声明的注释内容不一致，则具体的实现方法也需要用注释重写。 - - 如果方法实现的语义与接口声明的注释内容一致，则建议不写注释以避免重复的注释。 +- 如果方法实现的语义与接口声明的注释内容一致，则建议不写注释以避免重复的注释。 4. 在注释行中的第一个词需要大写，如 `param` 行，`return` 行。 如果特殊引用作为主题不需要大写，需要注意特殊符号，例如引号。 @@ -339,31 +336,29 @@ sidebar_position: 3 1. 更倾向于使用 `non-capturing` lambda（不包含对外部范围的引用的lambda）。 Capturing lambda 在每次调用时都需要创建一个新的对象实例。`Non-capturing` lambda 可以为每次调用使用相同的实例。 - - 负面示例： +- 负面示例： - ```java - map.computeIfAbsent(key, x -> key.toLowerCase()) - ``` - - - 正面示例： + ```java + map.computeIfAbsent(key, x -> key.toLowerCase()) + ``` +- 正面示例： - ```java - map.computeIfAbsent(key, k -> k.toLowerCase()); - ``` + ```java + map.computeIfAbsent(key, k -> k.toLowerCase()); + ``` 2. 考虑使用方法引用而不是内联lambda - - 负面示例： - - ```java - map.computeIfAbsent(key, k-> Loader.load(k)); - ``` +- 负面示例： - - 正面示例： + ```java + map.computeIfAbsent(key, k-> Loader.load(k)); + ``` +- 正面示例： - ```java - map.computeIfAbsent(key, Loader::load); - ``` + ```java + map.computeIfAbsent(key, Loader::load); + ``` ### 3.9 Java Streams @@ -381,186 +376,180 @@ sidebar_position: 3 1. 使用 `StringUtils.isBlank` 而不是 `StringUtils.isEmpty` - - 负面示例： - - ```java - if (StringUtils.isEmpty(name)) { - return; - } - ``` +- 负面示例： - - 正面示例： + ```java + if (StringUtils.isEmpty(name)) { + return; + } + ``` +- 正面示例： - ```java - if (StringUtils.isBlank(name)) { - return; - } - ``` + ```java + if (StringUtils.isBlank(name)) { + return; + } + ``` 2. 使用 `StringUtils.isNotBlank` 而不是 `StringUtils.isNotEmpty` - - 负面示例： - - ```java - if (StringUtils.isNotEmpty(name)) { - return; - } - ``` +- 负面示例： - - 正面示例： + ```java + if (StringUtils.isNotEmpty(name)) { + return; + } + ``` +- 正面示例： - ```java - if (StringUtils.isNotBlank(name)) { - return; - } - ``` + ```java + if (StringUtils.isNotBlank(name)) { + return; + } + ``` 3. 使用 `StringUtils.isAllBlank` 而不是 `StringUtils.isAllEmpty` - - 负面示例： - - ```java - if (StringUtils.isAllEmpty(name, age)) { - return; - } - ``` +- 负面示例： - - 正面示例： + ```java + if (StringUtils.isAllEmpty(name, age)) { + return; + } + ``` +- 正面示例： - ```java - if (StringUtils.isAllBlank(name, age)) { - return; - } - ``` + ```java + if (StringUtils.isAllBlank(name, age)) { + return; + } + ``` ### 3.12 `Enum` 类 1. 枚举值比较 - - 负面示例： +- 负面示例： - ```java - if (status.equals(JobStatus.RUNNING)) { - return; - } - ``` - - - 正面示例： + ```java + if (status.equals(JobStatus.RUNNING)) { + return; + } + ``` +- 正面示例： - ```java - if (status == JobStatus.RUNNING) { - return; - } - ``` + ```java + if (status == JobStatus.RUNNING) { + return; + } + ``` 2. 枚举类不需要实现 Serializable - - 负面示例： - - ```java - public enum JobStatus implements Serializable { - ... - } - ``` +- 负面示例： - - 正面示例： + ```java + public enum JobStatus implements Serializable { + ... + } + ``` +- 正面示例： - ```java - public enum JobStatus { - ... - } - ``` + ```java + public enum JobStatus { + ... + } + ``` 3. 使用 `Enum.name()` 而不是 `Enum.toString()` - - 负面示例： - - ```java - System.out.println(JobStatus.RUNNING.toString()); - ``` +- 负面示例： - - 正面示例： + ```java + System.out.println(JobStatus.RUNNING.toString()); + ``` +- 正面示例： - ```java - System.out.println(JobStatus.RUNNING.name()); - ``` + ```java + System.out.println(JobStatus.RUNNING.name()); + ``` 4. 枚举类名称统一使用 Enum 后缀 - - 负面示例： +- 负面示例： - ```java - public enum JobStatus { - ... - } - ``` - - - 正面示例： + ```java + public enum JobStatus { + ... + } + ``` +- 正面示例： - ```java - public enum JobStatusEnum { - ... - } - ``` + ```java + public enum JobStatusEnum { + ... + } + ``` ### 3.13 `Deprecated` 注解 - - 负面示例: +- 负面示例: - ```java - @deprecated - public void process(String input) { - ... - } - ``` +```java +@deprecated +public void process(String input) { + ... +} +``` - - 正面示例: +- 正面示例: - ```java - @Deprecated - public void process(String input) { - ... - } - ``` +```java +@Deprecated +public void process(String input) { + ... +} +``` ## 4 日志 1. 使用 `占位符` 进行日志输出： - - 负面示例 - ```java - log.info("Deploy cluster request " + deployRequest); - ``` - - 正面示例 - ```java - log.info("load plugin:{} to {}", file.getName(), appPlugins); - ``` +- 负面示例 -2. 打印日志时，注意选择 `日志级别` + ```java + log.info("Deploy cluster request " + deployRequest); + ``` +- 正面示例 - 当打印日志内容时，如果传递了日志占位符的实际参数，必须避免过早评估，以避免由日志级别导致的不必要评估。 + ```java + log.info("load plugin:{} to {}", file.getName(), appPlugins); + ``` - - 负面示例： +2. 打印日志时，注意选择 `日志级别` - 假设当前日志级别为 `INFO`： +当打印日志内容时，如果传递了日志占位符的实际参数，必须避免过早评估，以避免由日志级别导致的不必要评估。 - ```java - // 忽略声明行。 - List userList = getUsersByBatch(1000); - LOG.debug("All users: {}", getAllUserIds(userList)); - ``` +- 负面示例： - - 正面示例： + 假设当前日志级别为 `INFO`： - 在这种情况下，我们应该在进行实际的日志调用之前提前确定日志级别，如下所示： + ```java + // 忽略声明行。 + List userList = getUsersByBatch(1000); + LOG.debug("All users: {}", getAllUserIds(userList)); + ``` +- 正面示例： - ```java - // 忽略声明行。 - List userList = getUsersByBatch(1000); - if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); - } - ``` + 在这种情况下，我们应该在进行实际的日志调用之前提前确定日志级别，如下所示： + + ```java + // 忽略声明行。 + List userList = getUsersByBatch(1000); + if (LOG.isDebugEnabled()) { + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + } + ``` ## 5 测试 @@ -568,10 +557,15 @@ sidebar_position: 3 2. 实现的接口需在`e2e`模块下编写`e2e`测试用例脚本。 - ## 参考资料 + - https://site.mockito.org/ - https://alibaba.github.io/p3c/ - https://rules.sonarsource.com/java/ - https://junit.org/junit5/ - https://streampark.apache.org/ + +``` + +``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contact.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contact.md index 6167d13aa5f..0c574937517 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contact.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contact.md @@ -1,8 +1,9 @@ --- id: contact title: 交流联系 -sidebar_label: 交流联系 +sidebar_label: 交流联系 --- + > 如果您在使用过程有任何需要帮助或者想交流建议，可以通过 群 ISSUE 讨论交流。 [订阅邮件列表](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) : 发送邮件至 `dev-subscribe@hertzbeat.apache.org` 来订阅邮件列表. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md index e4aae1c519a..7223d9b5997 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md @@ -5,20 +5,20 @@ sidebar_position: 0 --- > 非常欢迎参与项目贡献，我们致力于维护一个互相帮助的快乐社区。 @@ -87,23 +87,31 @@ sidebar_position: 0 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 和其他贡献者进行代码审查。 @@ -148,14 +156,15 @@ git pull upstream master ### 模块 - **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务 + > 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。 -- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 +> - **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 > 使用通用协议远程采集获取对端指标数据。 -- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 +> - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 > 采集指标结果数据管理，数据落盘，查询，计算统计。 -- **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 +> - **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 > 告警计算触发，任务状态联动，告警配置，告警通知。 -- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 +> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 > 监控告警系统可视化控制台前端 ![hertzBeat](/img/docs/hertzbeat-arch.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md index 2bfebd21d2f..c9ed4b45859 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md @@ -1,7 +1,7 @@ --- id: development title: 如何将 HertzBeat 运行编译? -sidebar_label: 运行编译 +sidebar_label: 运行编译 --- ## 让 HertzBeat 运行起来 @@ -9,7 +9,6 @@ sidebar_label: 运行编译 > 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 - ### 后端启动 1. 需要 `maven3+`, `java17` 和 `lombok` 环境 @@ -38,7 +37,7 @@ sidebar_label: 运行编译 ## 生成二进制包 -> 需要 `maven3+`, `java17`, `node` 和 `yarn` 环境. +> 需要 `maven3+`, `java17`, `node` 和 `yarn` 环境. ### 前端打包 @@ -52,7 +51,6 @@ sidebar_label: 运行编译 5. 打包: `yarn package` - ### 后端打包 1. 需要 `maven3+`, `java17` 环境 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md index e696b3c35e4..4cf56e0137b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- 对于任何类型的软件来说，良好的文档都是至关重要的。任何能够改进 HertzBeat 文档的贡献都是受欢迎的。 @@ -93,3 +93,4 @@ css 和其他样式文件放在 `src/css` 目录中。 ### 页面内容修改 > 所有页面文档都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md index 0af99b19c08..1b79df79f85 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 @@ -12,7 +12,7 @@ sidebar_position: 4 - JDK 17 - Node18 Yarn -- Apache Maven 3.x +- Apache Maven 3.x - GnuPG 2.x - Git - SVN (Apache使用svn来托管项目发布) @@ -22,11 +22,11 @@ sidebar_position: 4 ## 2. 准备发布 > 首先整理帐户信息以更好地了解操作过程，稍后会多次使用。 -- apache id: `muchunjin (APACHE LDAP 用户名)` -- apache passphrase: `APACHE LDAP 密钥` -- apache email: `muchunjin@apache.org` -- gpg real name: `muchunjin (任何名称均可用, 在这里我将其设置为与apache id相同的名称)` -- gpg key passphrase: `创建gpg密钥时设置的密码，你需要记住此密码` +> - apache id: `muchunjin (APACHE LDAP 用户名)` +> - apache passphrase: `APACHE LDAP 密钥` +> - apache email: `muchunjin@apache.org` +> - gpg real name: `muchunjin (任何名称均可用, 在这里我将其设置为与apache id相同的名称)` +> - gpg key passphrase: `创建gpg密钥时设置的密码，你需要记住此密码` ### 2.1 生成密钥 @@ -130,7 +130,6 @@ gpg: unchanged: 1 或者进入 https://keyserver.ubuntu.com/ 网址，输入密钥的名称，然后点击'Search key' 按钮，查看是否有对应名称的密钥。 - #### 2.4 将 gpg 公钥添加到 Apache SVN 项目仓库的 KEYS 文件中 - Apache HertzBeat Dev 分支 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat @@ -230,9 +229,9 @@ release-1.6.0-rc1 #### 3.5 对二进制和源码包进行签名 -将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。 +将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。 -> 其中 `gpg -u 33545C76` 的 `33545C76` 是你的 GPG 密钥 ID，可以通过 `gpg --keyid-format SHORT --list-keys` 查看。 +> 其中 `gpg -u 33545C76` 的 `33545C76` 是你的 GPG 密钥 ID，可以通过 `gpg --keyid-format SHORT --list-keys` 查看。 ```shell cd dist @@ -341,7 +340,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" > `Send to`: dev@hertzbeat.apache.org
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
-> `Body`: +> `Body`: ``` Hello HertzBeat Community: @@ -404,8 +403,7 @@ Dear HertzBeat community, Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" I'm happy to announce the vote has passed: - - +--- 4 binding +1, from: - cc @@ -413,24 +411,20 @@ I'm happy to announce the vote has passed: 1 non-binding +1, from: - Roc Marshal - - +--- no 0 or -1 votes. Vote thread: https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq - - +--- Thank you to everyone who helped us to verify and vote for this release. We will move to the ASF Incubator voting shortly. - - +--- Best, ChunJin Mu ``` 邮件内容中的一项是`Vote thread`，在 https://lists.apache.org/list.html?dev@hertzbeat.apache.org 查看获取 - #### 3.2 发送孵化社区投票邮件 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。 @@ -476,17 +470,14 @@ More detailed checklist please refer: Steps to validate the release， Please refer to: • https://www.apache.org/info/verification.html • https://hertzbeat.apache.org/docs/community/how_to_verify_release - - +--- How to Build: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package - - +--- Thanks, On behalf of Apache HertzBeat (incubating) community - - +--- Best, ChunJin Mu ``` @@ -562,11 +553,14 @@ https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugi 然后输入发版标题和描述 -- 发版标题: +- 发版标题: + ``` v1.6.0 ``` + - 描述: + ``` xxx release note: xxx @@ -603,8 +597,7 @@ https://hertzbeat.apache.org/ HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues - Mailing list: dev@hertzbeat.apache.org - - +--- Apache HertzBeat Team Best, @@ -613,6 +606,6 @@ ChunJin Mu 该版本的发布顺利结束。 ----- +--- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md index ee4f9563c83..9904af1967b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md @@ -3,6 +3,7 @@ id: how_to_verify_release title: 版本物料的验证 sidebar_position: 4 --- + # 验证候选版本 详细检查列表请参考官方的[check list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist) @@ -21,12 +22,10 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio ``` - ## 2. 验证上传的版本是否合规 > 开始验证环节，验证包含但不局限于以下内容和形式 - ### 2.1 查看发布包是否完整 > 上传到dist的包必须包含源码包，二进制包可选 @@ -36,7 +35,6 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio 3. 是否包含源码包的sha512 4. 如果上传了二进制包，则同样检查(2)-(4)所列的内容 - ### 2.2 检查gpg签名 首先导入发布人公钥。从svn仓库导入KEYS到本地环境。（发布版本的人不需要再导入，帮助做验证的人需要导入，用户名填发版人的即可） @@ -47,6 +45,7 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio $ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS $ gpg --import KEYS # 导入KEYS到本地 ``` + #### 2.2.2 信任公钥 > 信任此次版本所使用的KEY @@ -75,6 +74,7 @@ Do you really want to set this key to ultimate trust? (y/N) y #选择y gpg> ``` + #### 2.2.3 检查签名 ```shell @@ -82,6 +82,7 @@ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done ``` 检查结果 + > 出现类似以下内容则说明签名正确，关键字：**`Good signature`** ```shell @@ -95,7 +96,6 @@ gpg: Good signature from "xxx @apache.org>" > 本地计算sha512哈希后，验证是否与dist上的一致，如果上传二进制包，则同样需要检查二进制包的sha512哈希 - ```shell for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done ``` @@ -123,7 +123,6 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz 参考: https://apache.org/legal/resolved.html - ### 2.5. 源码编译验证 解压缩 `apache-hertzbeat-${release_version}-incubating-src.tar.gz` @@ -132,7 +131,7 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz cd apache-hertzbeat-${release_version}-incubating-src ``` -编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package +编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package 进行如下检查: @@ -148,7 +147,6 @@ cd apache-hertzbeat-${release_version}-incubating-src 参考: https://apache.org/legal/resolved.html - ## 3. 邮件回复 如果发起了发布投票，验证后，可以参照此回复示例进行邮件回复 @@ -169,11 +167,11 @@ IPMC 在 general@incubator.apache.org incubator 社区投票，请带上 binding Forward my +1 from dev@hertzbeat (non-binding) Copy my +1 from hertzbeat DEV ML (non-binding) ``` -::: - +::: 非PPMC/IPMC成员 + ```html +1 (non-binding) I checked: @@ -185,6 +183,7 @@ I checked: ``` PPMC/IPMC成员 + ```html //incubator社区 投票时，只有IPMC成员才具有约束性 binding +1 (binding) @@ -196,7 +195,6 @@ I checked: 5. .... ``` - --- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md index 57de5409834..922cbfe9a6a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- [开发者邮件列表](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) 是社区推荐的沟通和获取最新信息的方式。 @@ -32,19 +32,17 @@ sidebar_position: 1 - 使用此列表提出您对 HertzBeat 的问题 - 由 HertzBeat 贡献者用来讨论 HertzBeat 的开发 - -| 列表名称 | 地址 | 订阅 | 退订 | 归档 | -|--------------|------------------------------|------------------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------------| -| **开发者列表** | dev@hertzbeat.apache.org | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | - +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|-----------|--------------------------|-------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------| +| **开发者列表** | dev@hertzbeat.apache.org | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | ### 通知列表 - 关于 HertzBeat 代码库的更改的通知，频繁通知 -| 列表名称 | 地址 | 订阅 | 退订 | 归档 | -|-----------|------------------------------|-------------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------| -| **通知列表** | notifications@hertzbeat.apache.org | [订阅](mailto:notifications-subscribe@hertzbeat.apache.org) | [退订](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|----------|------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------| +| **通知列表** | notifications@hertzbeat.apache.org | [订阅](mailto:notifications-subscribe@hertzbeat.apache.org) | [退订](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | ## 订阅步骤 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md index 5bb52e0a425..c4c61aac4bc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md @@ -5,20 +5,20 @@ sidebar_position: 4 --- [官方指南](https://community.apache.org/newcommitter.html#new-committer-process) @@ -49,7 +49,6 @@ sidebar_position: 4 - 等待root告诉我们已经完成 - [Roster](https://whimsy.apache.org/roster/ppmc/hertzbeat) 添加新的 committer - - Announce New Committer 参见 **Announce New Committer Template** @@ -285,7 +284,9 @@ Best Wishes! ## 详细步骤 ### 接受邀请 + 当通过PMC内部投票后，PMC会向您索要个人邮箱，之后您会收到一封邮件，邮件会指引您进行下一步操作，内容为: + ``` Hello xxxx, @@ -371,14 +372,14 @@ hi, i accept. Thanks for invitaion. ![](/img/docs/community/icla-content-2.png) 在PDF中需要填写的字段： - - `Full name` - - `Public name` - - `Postal Address` - - `Country` - - `E-Mail` - - `(optional) preferred Apache id(s)` - - `(optional) notify project` - - `Date` +- `Full name` +- `Public name` +- `Postal Address` +- `Country` +- `E-Mail` +- `(optional) preferred Apache id(s)` +- `(optional) notify project` +- `Date` > 填写样例 > ![](/img/docs/community/icla-content-3.png) @@ -450,6 +451,7 @@ Thanks ! ![](/img/docs/community/account-6.png) 邮箱中会收到一封邮件，点击`Join @apache` + > 这里邮箱指的是您提供给PMC的那个邮箱地址 ![](/img/docs/community/account-7.png) @@ -460,6 +462,7 @@ Thanks ! ![](/img/docs/community/account-9.png) 回到Apache页面，提示GitHub启用多重身份认证，在GitHub页面启用双重身份认证 + > GitHub双重身份认证介绍，[点击跳转官方文档](https://docs.github.com/zh/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) ![](/img/docs/community/account-10.png) @@ -472,7 +475,6 @@ Thanks ! 最后一步，联系PMC主席开启svn和其他访问权限。 - ## 邮箱绑定 ### GMail邮箱绑定 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md index 4488f1fcfea..d7e144bb52b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md @@ -5,20 +5,20 @@ sidebar_position: 5 --- 这个指南是基于 [apache newcommitter](https://community.apache.org/newcommitter.html#new-committer-process) 的。 @@ -82,7 +82,6 @@ ${Work list}[1] [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) [Apache 参考投票指南](https://community.apache.org/newcommitter.html) - ### Close Vote Template ```text @@ -284,3 +283,4 @@ A PPMC member helps manage and guide the direction of the project. Thanks, On behalf of the Apache HertzBeat (incubating) PPMC ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md index ee553bb6e1c..8940571f71c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md @@ -5,72 +5,64 @@ sidebar_position: 2 --- - * 首先从远程仓库 将代码的一份副本 fork 到您自己的仓库 * 远程仓库开发合并分支：`master` * 将您fork仓库clone到您的本地设备 - ```shell - git clone git@github.com:<您的账户名>/hertzbeat.git - ``` - + ```shell + git clone git@github.com:<您的账户名>/hertzbeat.git + ``` * 添加远程仓库地址，命名为 upstream - ```shell - git remote add upstream git@github.com:apache/hertzbeat.git - ``` - + ```shell + git remote add upstream git@github.com:apache/hertzbeat.git + ``` * 查看仓库 - ```shell - git remote -v - ``` + ```shell + git remote -v + ``` > 此时会有两个仓库：origin（您自己的仓库）和 upstream（远程仓库） * 获取/更新远程仓库代码 - ```shell - git fetch upstream - ``` - + ```shell + git fetch upstream + ``` * 将远程仓库代码同步到本地仓库 - ```shell - git checkout origin/master - git merge --no-ff upstream/master - ``` - + ```shell + git checkout origin/master + git merge --no-ff upstream/master + ``` * **⚠️注意一定要新建分支开发特性 `git checkout -b feature-xxx`，不建议使用master分支直接开发** - * 在本地修改代码后，提交到自己的仓库： - **注意提交信息为英文，不包含特殊字符** - ```shell - git commit -m '[docs]necessary instructions' - git push - ``` + **注意提交信息为英文，不包含特殊字符** + ```shell + git commit -m '[docs]necessary instructions' + git push + ``` * 将更改提交到远程仓库后，您可以在您的仓库页面上看到一个绿色的按钮“Compare & pull request”，点击它。 - * 这会弹出新建 Pull Request 页面，您需要这里仔细填写信息(英文)，描述和代码同样重要，然后点击“Create pull request”按钮。 - * 然后社区的 Committers 将进行 CodeReview，并与您讨论一些细节（包括设计、实现、性能等），之后您可以根据建议直接在这个分支更新代码(无需新建PR)。当社区 Committer approve之后，提交将被合并到 master 分支。 - * 最后，恭喜您，您已经成为 HertzBeat 的官方贡献者，您会被加在贡献者墙上，您可以联系社区获取贡献者证书！ + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md index dedb919ebfc..c4b43f355ac 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md @@ -18,11 +18,9 @@ sidebar_label: Download 以前版本的 HertzBeat 可能会受到安全问题的影响，请考虑使用最新版本。 ::: - -| 版本 | 日期 | 下载 | Release Notes | -|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| -| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | - +| 版本 | 日期 | 下载 | Release Notes | +|--------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | ## Docker 镜像版本 @@ -31,7 +29,6 @@ sidebar_label: Download - HertzBeat https://hub.docker.com/r/apache/hertzbeat - HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector - ## 归档版本 在这里查看所有归档版本：[archive](https://archive.apache.org/dist/incubator/hertzbeat/). diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md index b2d8f1489f5..29d5478158a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 **使用协议：JMX** -### 监控前操作 +### 监控前操作 > 您需要在 ActiveMQ 开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 ActiveMQ 进行指标采集。 @@ -23,9 +23,10 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 ``` -2. 修改安装目录下的 `bin/env` 文件，配置JMX 端口 IP等 +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" @@ -34,7 +35,9 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" ``` -更新为如下配置，⚠️注意修改`本机对外IP` + +更新为如下配置，⚠️注意修改`本机对外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" @@ -49,25 +52,25 @@ 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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 监控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. | @@ -88,57 +91,56 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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 | - +#### 指标集合：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 | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md index bf8d7570c59..a2e61c704fe 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md @@ -9,52 +9,54 @@ keywords: [人工智能 AI] ### 配置参数说明 -| 参数名称 | 参数帮助描述 | -| ----------- |------------------------------| -| type | 选择AI大模型（如智普、通义千问...） | -| model | 选择模型，默认为GLM-4 | -| api-key | 获取api_key，如果没有该配置，无法与大模型进行对话 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------| +| type | 选择AI大模型（如智普、通义千问...） | +| model | 选择模型，默认为GLM-4 | +| api-key | 获取api_key，如果没有该配置，无法与大模型进行对话 | ### 大模型选项与配置详解 #### 智普AI -| 参数名称 | 示例 | 链接 | -|--------------|-----------------------------------------------------|----| -| type | zhiPu（必须和示例完全相同） | 无 | -| model | glm-4-0520、glm-4 、glm-4-air、glm-4-airx、 glm-4-flash | 无 | -| api-key | xxxxx.xxxxxx | https://open.bigmodel.cn/login?redirect=%2Fusercenter%2Fapikeys | +| 参数名称 | 示例 | 链接 | +|---------|-----------------------------------------------------|-----------------------------------------------------------------| +| type | zhiPu（必须和示例完全相同） | 无 | +| model | glm-4-0520、glm-4 、glm-4-air、glm-4-airx、 glm-4-flash | 无 | +| api-key | xxxxx.xxxxxx | https://open.bigmodel.cn/login?redirect=%2Fusercenter%2Fapikeys | #### 阿里巴巴AI -| 参数名称 | 示例 | 链接 | -|--------------|----------------------------------------------------|----| -| type | alibabaAi（必须和示例完全相同） | 无 | -| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | https://help.aliyun.com/zh/dashscope/developer-reference/model-introduction?spm=a2c4g.11186623.0.0.4e0246c1RQFKMH | -| api-key | xxxxxxxxxxx | https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key?spm=a2c4g.11186623.0.i10 | +| 参数名称 | 示例 | 链接 | +|---------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| type | alibabaAi（必须和示例完全相同） | 无 | +| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | https://help.aliyun.com/zh/dashscope/developer-reference/model-introduction?spm=a2c4g.11186623.0.0.4e0246c1RQFKMH | +| api-key | xxxxxxxxxxx | https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key?spm=a2c4g.11186623.0.i10 | #### 月之暗面AI -| 参数名称 | 示例 | 链接 | -|--------------|----------------------------------------------------|-----------------------------------------------| -| type | kimiAi（必须和示例完全相同） | 无 | -| model | moonshot-v1-8k、moonshot-v1-32k、moonshot-v1-128k | 无 | -| api-key | xxxxxxxxxxx | https://platform.moonshot.cn/console/api-keys | +| 参数名称 | 示例 | 链接 | +|---------|-------------------------------------------------|-----------------------------------------------| +| type | kimiAi（必须和示例完全相同） | 无 | +| model | moonshot-v1-8k、moonshot-v1-32k、moonshot-v1-128k | 无 | +| api-key | xxxxxxxxxxx | https://platform.moonshot.cn/console/api-keys | #### 科大讯飞AI + 快速入门：https://www.xfyun.cn/doc/platform/quickguide.html -| 参数名称 | 示例 | 链接 | -|--------------|-------------------------------------------------|---------------------------------------------------------------| -| type | sparkDesk (must be exactly the same as example) | | -| model | general、generalv2、generalv3、generalv3.5、4.0Ultra | | -| api-key | xxxxxxxxxxx |https://console.xfyun.cn/services/cbm| -| api-secret | xxxxxxxxxxx |https://console.xfyun.cn/services/cbm| +| 参数名称 | 示例 | 链接 | +|------------|--------------------------------------------------|---------------------------------------| +| type | sparkDesk (must be exactly the same as example) | | +| model | general、generalv2、generalv3、generalv3.5、4.0Ultra | | +| api-key | xxxxxxxxxxx | https://console.xfyun.cn/services/cbm | +| api-secret | xxxxxxxxxxx | https://console.xfyun.cn/services/cbm | -| 模型版本 | 模型类型(application.yml的model参数) | +| 模型版本 | 模型类型(application.yml的model参数) | |-----------------|-------------------------------| -| Spark4.0 Ultra | 4.0Ultra | -| Spark Max | generalv3.5 | +| Spark4.0 Ultra | 4.0Ultra | +| Spark Max | generalv3.5 | | Spark Pro | generalv3 | -| Spark V2.0 | generalv2 | -| Spark Lite(免费版) | general | \ No newline at end of file +| Spark V2.0 | generalv2 | +| Spark Lite(免费版) | general | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md index 5323ede8110..52367155d89 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md @@ -9,33 +9,31 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：airflow_health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | -------------------- | -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|------------------| +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | #### 指标集合：airflow_version -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | --------------- | -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------| +| value | 无 | Airflow版本 | +| git_version | 无 | Airflow git版本 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_console.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_console.md index 68cf7339eae..5198b961b66 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_console.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_console.md @@ -6,13 +6,13 @@ sidebar_label: 告警模板登录台地址 > 阈值触发后发送告警信息，通过钉钉/企业微信/飞书机器人通知或者使用邮箱通知的时候，告警内容中有登录控制台的详情链接 - ### 自定义设置 在我们的启动配置文件application.yml中，找到下面的配置 + ```yml alerter: console-url: #这里就是我们的自定义控制台地址 ``` -默认值是赫兹跳动的官方控制台地址 \ No newline at end of file +默认值是赫兹跳动的官方控制台地址 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md index aec6342f7d3..9d0ee3b088f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md @@ -5,15 +5,15 @@ sidebar_label: 告警钉钉机器人通知 keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 +> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 -### 操作步骤 +### 操作步骤 1. **【钉钉桌面客户端】-> 【群设置】-> 【智能群助手】-> 【添加新建机器人-选自定义】-> 【设置机器人名称头像】-> 【注意⚠️设置自定义关键字: HertzBeat】 ->【添加成功后复制其WebHook地址】** -> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 +> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 -![email](/img/docs/help/alert-notice-8.png) +![email](/img/docs/help/alert-notice-8.png) 2. **【保存机器人的WebHook地址access_token值】** @@ -24,18 +24,18 @@ keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警 ![email](/img/docs/help/alert-notice-9.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 钉钉机器人通知常见问题 -### 钉钉机器人通知常见问题 +1. 钉钉群未收到机器人告警通知 -1. 钉钉群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查钉钉机器人是否配置了安全自定义关键字：HertzBeat > 请排查是否配置正确机器人ACCESS_TOKEN，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md index d6c4879a2ba..9694126d0dd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md @@ -5,68 +5,66 @@ sidebar_label: 告警 Discord 机器人通知 keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 +> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 -### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token +### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token -1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 +1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 ![bot](/img/docs/help/discord-bot-1.png) -2. 在应用下创建机器人，获取机器人 Token +2. 在应用下创建机器人，获取机器人 Token ![bot](/img/docs/help/discord-bot-2.png) ![bot](/img/docs/help/discord-bot-3.png) -3. 授权机器人到聊天服务器 +3. 授权机器人到聊天服务器 -> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` +> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` ![bot](/img/docs/help/discord-bot-4.png) > 获取到最下方生成的 URL, 浏览器访问此 URL 给机器人正式授权，即设置将机器人加入哪个聊天服务器。 -4. 查看您的聊天服务器是否已经加入机器人成员 +4. 查看您的聊天服务器是否已经加入机器人成员 ![bot](/img/docs/help/discord-bot-5.png) -### 开启开发者模式，获取频道 Channel ID +### 开启开发者模式，获取频道 Channel ID -1. 个人设置 -> 高级设置 -> 开启开发者模式 +1. 个人设置 -> 高级设置 -> 开启开发者模式 ![bot](/img/docs/help/discord-bot-6.png) -2. 获取频道 Channel ID +2. 获取频道 Channel ID -> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID +> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID ![bot](/img/docs/help/discord-bot-7.png) - -### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot +### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot 1. **【告警通知】->【新增接收人】 ->【选择 Discord 机器人通知方式】->【设置机器人Token和ChannelId】-> 【确定】** ![email](/img/docs/help/discord-bot-8.png) -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -![email](/img/docs/help/alert-notice-policy.png) +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +![email](/img/docs/help/alert-notice-policy.png) -### Discord 机器人通知常见问题 +### Discord 机器人通知常见问题 -1. Discord 未收到机器人告警通知 +1. Discord 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 > 请排查机器人是否被 Discord聊天服务器正确赋权 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md index 7033f6036d6..d4dc218c591 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md @@ -5,34 +5,35 @@ sidebar_label: 告警邮件通知 keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过邮件通知到接收人。 +> 阈值触发后发送告警信息，通过邮件通知到接收人。 -### 操作步骤 +### 操作步骤 -1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** +1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** -![email](/img/docs/help/alert-notice-1.png) +![email](/img/docs/help/alert-notice-1.png) 2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** -![email](/img/docs/help/alert-notice-2.png) + ![email](/img/docs/help/alert-notice-2.png) -![email](/img/docs/help/alert-notice-3.png) +![email](/img/docs/help/alert-notice-3.png) -3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 邮件通知常见问题 -### 邮件通知常见问题 +1. 自己内网部署的HertzBeat无法接收到邮件通知 -1. 自己内网部署的HertzBeat无法接收到邮件通知 -> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 +> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 + +2. 云环境TanCloud无法接收到邮件通知 -2. 云环境TanCloud无法接收到邮件通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确邮箱，是否已配置告警策略关联 -> 请查询邮箱的垃圾箱里是否把告警邮件拦截 +> 请查询邮箱的垃圾箱里是否把告警邮件拦截 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_enterprise_wechat_app.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_enterprise_wechat_app.md index 3f1c5a2b9c1..b70c8b10c40 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_enterprise_wechat_app.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_enterprise_wechat_app.md @@ -5,28 +5,28 @@ sidebar_label: 企业微信应用告警通知 keywords: [开源告警系统, 开源监控告警系统, 企业微信应用告警通知] --- -> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. +> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. -### Operation steps +### Operation steps 1. **【企业微信后台管理】-> 【App管理】-> 【创建一个新的应用】-> 【设置应用信息】->【添加成功后复制应用的AgentId和Secret】** -![email](/img/docs/help/alert-wechat-1.jpg) +![email](/img/docs/help/alert-wechat-1.jpg) 2. **【告警通知】->【新增接收人】 ->【选择企业微信应用通知方式】->【设置企业ID,企业应用id和应用的secret 】-> 【确定】** ![email](/img/docs/help/alert-wechat-2.jpg) -3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** -![email](/img/docs/help/alert-wechat-3.jpg) +![email](/img/docs/help/alert-wechat-3.jpg) +### 企业微信应用通知常见问题 -### 企业微信应用通知常见问题 +1. 企业微信应用未收到告警通知. -1. 企业微信应用未收到告警通知. > 请检查用户是否具有应用程序权限. > 请检查企业应用程序回调地址设置是否正常. > 请检查服务器IP是否在企业应用程序白名单上. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md index 448e70de223..604eff34fdc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md @@ -5,30 +5,30 @@ sidebar_label: 告警飞书机器人通知 keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 +> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 -### 操作步骤 +### 操作步骤 1. **【飞书客户端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** -2. **【保存机器人的WebHook地址的KEY值】** +2. **【保存机器人的WebHook地址的KEY值】** > 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 飞书机器人通知常见问题 -### 飞书机器人通知常见问题 +1. 飞书群未收到机器人告警通知 -1. 飞书群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 +> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md index e137d07e9e2..c81f5608674 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md @@ -5,34 +5,33 @@ sidebar_label: 告警 Slack Webhook 通知 keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 +> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 -### 在 Slack 开启 Webhook, 获取 Webhook URL +### 在 Slack 开启 Webhook, 获取 Webhook URL -参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) +参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) -### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook +### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook 1. **【告警通知】->【新增接收人】 ->【选择 Slack Webhook 通知方式】->【设置 Webhook URL】-> 【确定】** ![email](/img/docs/help/slack-bot-1.png) -2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 -![email](/img/docs/help/alert-notice-policy.png) +![email](/img/docs/help/alert-notice-policy.png) +### Slack 机器人通知常见问题 -### Slack 机器人通知常见问题 - -1. Slack 未收到机器人告警通知 +1. Slack 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 +> 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md index 6730aa19dcb..df609e66b50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md @@ -5,22 +5,22 @@ sidebar_label: 告警 Telegram 机器人通知 keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 +> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 ### 在 Telegram 创建机器人, 获取 Bot Token 和 UserId -1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` +1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` ![telegram-bot](/img/docs/help/telegram-bot-1.png) -2. 获取接收人的 `User ID` +2. 获取接收人的 `User ID` -**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, -访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` +**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, +访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` ```json { @@ -42,27 +42,26 @@ keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] } ``` -3. 记录保存我们获得的 `Token` 和 `User Id` +3. 记录保存我们获得的 `Token` 和 `User Id` -### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot +### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot 1. **【告警通知】->【新增接收人】 ->【选择 Telegram 机器人通知方式】->【设置机器人Token和UserId】-> 【确定】** ![email](/img/docs/help/telegram-bot-2.png) -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 -![email](/img/docs/help/alert-notice-policy.png) +![email](/img/docs/help/alert-notice-policy.png) +### Telegram 机器人通知常见问题 -### Telegram 机器人通知常见问题 - -1. Telegram 未收到机器人告警通知 +1. Telegram 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 -> UserId 应为消息接收对象的UserId +> UserId 应为消息接收对象的UserId -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold.md index 401a3d04d45..a41ae531e28 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold.md @@ -3,6 +3,7 @@ id: alert_threshold title: 阈值告警配置 sidebar_label: 阈值告警配置 --- + > 对监控指标配置告警阈值(警告告警，严重告警，紧急告警)，系统根据阈值配置和采集指标数据计算触发告警。 ## 操作步骤 @@ -20,6 +21,7 @@ sidebar_label: 阈值告警配置 如上图所示，新增标签，这里我们设置标签为: linux:dev (开发环境使用Linux) #### 配置标签 + TODO 图片名称更新 ![threshold](/img/docs/help/alert-threshold-3.png) @@ -47,7 +49,6 @@ TODO 图片名称更新 - **恢复通知**：告警触发后是否发送恢复通知，默认不发送。 - **启用告警**：此告警阈值配置开启生效或关闭 - **阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。** **若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold_expr.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold_expr.md index 5924d8965f8..37a9fb29d1b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold_expr.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_threshold_expr.md @@ -3,11 +3,11 @@ id: alert_threshold_expr title: 阈值触发表达式 sidebar_label: 阈值触发表达式 --- + > 在我们配置阈值告警时，需要配置阈值触发表达式，系统根据表达式和监控指标值计算触发是否告警，这里详细介绍下表达式使用。 #### 表达式支持的操作符 - | 运算符(可视化配置) | 运算符(表达式配置) | 支持类型 | 说明 | | | ------------------ | -------------------- | ----------------------- | ------------------------ | - | | 等于 | equals(str1,str2) | 字符型 | 判断字符串是否相等 | | @@ -27,22 +27,21 @@ sidebar_label: 阈值触发表达式 #### 表达式函数库列表 - -| 支持函数库 | 说明 | -| -------------------------------------------- | ------------------------------------------------------------------ | -| condition ? trueExpression : falseExpression | 三元运算符 | -| toDouble(str) | 将字符串转换为Double类型 | -| toBoolean(str) | 将字符串转换为Boolean类型 | -| toInteger(str) | 将字符串转换为Integer类型 | -| array[n] | 取数组第n个元素 | -| * | 算法乘 | -| / | 算法除 | -| % | 求余 | -| ( 和 ) | 括号用于控制运算的优先级，确保在逻辑或数学表达式中某些部分先被计算 | -| + | 加号用于表示数学中的加法运算、字符串拼接 | -| - | 减号用于表示数学中的减法运算 | -| && | 逻辑AND操作符 | -| \|\| | 逻辑OR操作符 | +| 支持函数库 | 说明 | +|----------------------------------------------|-----------------------------------| +| condition ? trueExpression : falseExpression | 三元运算符 | +| toDouble(str) | 将字符串转换为Double类型 | +| toBoolean(str) | 将字符串转换为Boolean类型 | +| toInteger(str) | 将字符串转换为Integer类型 | +| array[n] | 取数组第n个元素 | +| * | 算法乘 | +| / | 算法除 | +| % | 求余 | +| ( 和 ) | 括号用于控制运算的优先级，确保在逻辑或数学表达式中某些部分先被计算 | +| + | 加号用于表示数学中的加法运算、字符串拼接 | +| - | 减号用于表示数学中的减法运算 | +| && | 逻辑AND操作符 | +| \|\| | 逻辑OR操作符 | #### 支持的环境变量 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md index 61ed1dc99b5..022cd50f07e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md @@ -5,23 +5,24 @@ sidebar_label: 告警 Webhook 回调通知 keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 +> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 -## 操作步骤 +## 操作步骤 -1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** +1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** ![email](/img/docs/help/alert-notice-5.png) -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) -### WebHook回调POST请求体BODY内容 +### WebHook回调POST请求体BODY内容 + +内容格式：JSON -内容格式：JSON ```json { "alarmId": 76456, @@ -43,22 +44,23 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 } ``` -| | | -|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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} | +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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通知常见问题 -### webhook通知常见问题 +1. WebHook回调未生效 -1. WebHook回调未生效 > 请查看告警中心是否已经产生此条告警信息 > 请排查配置的WebHook回调地址是否正确 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md index ce73c131d00..e0dbabf1a70 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md @@ -5,34 +5,34 @@ sidebar_label: 告警企业微信通知 keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 +> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 -### 操作步骤 +### 操作步骤 -1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** +1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** -![email](/img/docs/help/alert-notice-6.jpg) +![email](/img/docs/help/alert-notice-6.jpg) -2. **【保存机器人的WebHook地址的KEY值】** +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` +> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** +3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** ![email](/img/docs/help/alert-notice-7.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 企业微信机器人通知常见问题 -### 企业微信机器人通知常见问题 +1. 企业微信群未收到机器人告警通知 -1. 企业微信群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 +> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md index 64f15c3777d..391005c080c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md @@ -4,114 +4,105 @@ title: 监控：AlmaLinux操作系统监控 sidebar_label: AlmaLinux操作系统 keywords: [开源监控系统, 开源操作系统监控, AlmaLinux操作系统监控] --- + > 对AlmaLinux操作系统的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- | ------------------------------------------------------------------------- | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -| 密钥 | 连接服务器所需密钥 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | ### 采集指标 #### 指标集合：系统基本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Host Name | 无 | 主机名称 | -| System Version | 无 | 操作系统版本 | -| Uptime | 无 | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | #### 指标集合：CPU 信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | --------------------------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | #### 指标集合：内存信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------- | -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：磁盘信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------- | -------- | ------------------ | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：网卡信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：文件系统 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | -------------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | #### 指标集合：Top10 CPU进程 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| cpu_usage | % | CPU占用率 | -| mem_usage | % | 内存占用率 | -| command | 无 | 执行命令 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | #### 指标集合：Top10 内存进程 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| mem_usage | % | 内存占用率 | -| cpu_usage | % | CPU占用率 | -| command | 无 | 执行命令 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md index 9b80fc35828..89f3cd701bc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md @@ -5,34 +5,33 @@ sidebar_label: HTTP API keywords: [开源监控系统, 开源网站监控, HTTP API监控] --- -> 调用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认证时使用的密码 | -| 请求Headers | HTTP 请求头 | -| 查询Params | HTTP查询参数,支持[时间表达式](time_expression) | -| Content-Type | 设置携带BODY请求体数据请求时的资源类型 | -| 请求BODY | 设置携带BODY请求体数据，PUT POST请求方式时有效 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------------|-------------------------------------------------------------------| +| 监控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认证时使用的密码 | +| 请求Headers | HTTP 请求头 | +| 查询Params | HTTP查询参数,支持[时间表达式](time_expression) | +| Content-Type | 设置携带BODY请求体数据请求时的资源类型 | +| 请求BODY | 设置携带BODY请求体数据，PUT POST请求方式时有效 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md index 03c514bc7b8..3d0654db3b5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md index 1c5adeeccc2..955c87b4e4f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md @@ -4,96 +4,93 @@ title: 监控：Clickhouse数据库监控 sidebar_label: Clickhouse数据库 keywords: [开源监控系统, 开源数据库监控, Clickhouse数据库监控] --- + > 对Clickhouse数据库的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------------------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为8123。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为8123。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：ping 可用性 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------ | -| responseTime | 无 | 响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | 无 | 响应时间 | #### 指标集合：system.metrics表的数据 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | -------------------------------------- | -| Query | 无 | 正在执行的查询的数量 | -| Merge | 无 | 正在执行的后台合并的数量 | -| Move | 无 | 正在执行的后台移动的数量 | -| PartMutation | 无 | 表变更的次数 | -| ReplicatedFetch | 无 | 从副本收集的数据块数量 | -| ReplicatedSend | 无 | 发送到副本的数量块数量 | -| ReplicatedChecks | 无 | 检查一致性的数据块数量 | -| QueryPreempted | 无 | 停止或等待的查询数量 | -| TCPConnection | 无 | TCP连接数量 | -| HTTPConnection | 无 | HTTP连接数量 | -| OpenFileForRead | 无 | 打开的可读文件的数量 | -| OpenFileForWrite | 无 | 打开的可写文件的数量 | -| QueryThread | 无 | 查询处理的线程数量 | -| ReadonlyReplica | 无 | 处于只读状态的 Replicated table 的数量 | -| EphemeralNode | 无 | ZooKeeper 中保存的临时节点数 | -| ZooKeeperWatch | 无 | ZooKeeper事件订阅数 | -| StorageBufferBytes | Bytes | Buffer tables 中的字节数 | -| VersionInteger | 无 | ClickHouse 版本号 | -| RWLockWaitingReaders | 无 | 等待读表的读写锁的线程数量 | -| RWLockWaitingWriters | 无 | 等待写表的读写锁的线程数量 | -| RWLockActiveReaders | 无 | 在一个表的读写锁中持有读锁的线程数 | -| RWLockActiveWriters | 无 | 在一个表的读写锁中持有写锁的线程数 | -| GlobalThread | 无 | 全局线程池中的线程数 | -| GlobalThreadActive | 无 | 全局线程池中活跃的线程数 | -| LocalThread | 无 | 本地线程池中的线程数 | -| LocalThreadActive | 无 | 本地线程池中活跃的线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|-------|------------------------------| +| Query | 无 | 正在执行的查询的数量 | +| Merge | 无 | 正在执行的后台合并的数量 | +| Move | 无 | 正在执行的后台移动的数量 | +| PartMutation | 无 | 表变更的次数 | +| ReplicatedFetch | 无 | 从副本收集的数据块数量 | +| ReplicatedSend | 无 | 发送到副本的数量块数量 | +| ReplicatedChecks | 无 | 检查一致性的数据块数量 | +| QueryPreempted | 无 | 停止或等待的查询数量 | +| TCPConnection | 无 | TCP连接数量 | +| HTTPConnection | 无 | HTTP连接数量 | +| OpenFileForRead | 无 | 打开的可读文件的数量 | +| OpenFileForWrite | 无 | 打开的可写文件的数量 | +| QueryThread | 无 | 查询处理的线程数量 | +| ReadonlyReplica | 无 | 处于只读状态的 Replicated table 的数量 | +| EphemeralNode | 无 | ZooKeeper 中保存的临时节点数 | +| ZooKeeperWatch | 无 | ZooKeeper事件订阅数 | +| StorageBufferBytes | Bytes | Buffer tables 中的字节数 | +| VersionInteger | 无 | ClickHouse 版本号 | +| RWLockWaitingReaders | 无 | 等待读表的读写锁的线程数量 | +| RWLockWaitingWriters | 无 | 等待写表的读写锁的线程数量 | +| RWLockActiveReaders | 无 | 在一个表的读写锁中持有读锁的线程数 | +| RWLockActiveWriters | 无 | 在一个表的读写锁中持有写锁的线程数 | +| GlobalThread | 无 | 全局线程池中的线程数 | +| GlobalThreadActive | 无 | 全局线程池中活跃的线程数 | +| LocalThread | 无 | 本地线程池中的线程数 | +| LocalThreadActive | 无 | 本地线程池中活跃的线程数 | #### 指标集合：system.events表的数据 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------------------------- |-------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------------|-------|------------------------------------------------------------------------------------------------| | Query | 无 | 要解释和可能执行的查询数量。 不包括由于 AST 大小限制、配额限制或同时运行的查询数量限制而无法解析或被拒绝的查询。 可能包括 ClickHouse 本身发起的内部查询。 不计算子查询。 | -| SelectQuery | 无 | 可能执行的 Select 查询数 | -| InsertQuery | 无 | 可能执行的 Insert 查询数 | -| InsertedRows | 无 | 被插入到所有表中的行数 | -| InsertedBytes | Bytes | 被插入到所有表中的字节数 | -| FailedQuery | 无 | 执行失败的查询数量 | -| FailedSelectQuery | 无 | 执行失败的 Select 查询数量 | -| FileOpen | 无 | 文件打开数 | -| MergeTreeDataWriterRows | 无 | 写入 MergeTree 表的数据行数 | -| MergeTreeDataWriterCompressedBytes | Bytes | 压缩写入 MergeTree 表的数据字节数 | +| SelectQuery | 无 | 可能执行的 Select 查询数 | +| InsertQuery | 无 | 可能执行的 Insert 查询数 | +| InsertedRows | 无 | 被插入到所有表中的行数 | +| InsertedBytes | Bytes | 被插入到所有表中的字节数 | +| FailedQuery | 无 | 执行失败的查询数量 | +| FailedSelectQuery | 无 | 执行失败的 Select 查询数量 | +| FileOpen | 无 | 文件打开数 | +| MergeTreeDataWriterRows | 无 | 写入 MergeTree 表的数据行数 | +| MergeTreeDataWriterCompressedBytes | Bytes | 压缩写入 MergeTree 表的数据字节数 | #### 指标集合：system.asynchronous_metrics表的数据 +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------------------|------|----------------------------------| +| AsynchronousMetricsCalculationTimeSpent | 无 | 异步指标计算花费的时间（秒） | +| jemalloc.arenas.all.muzzy_purged | 无 | 被清除的模糊（muzzy）页的数量 | +| jemalloc.arenas.all.dirty_purged | 无 | 被清除的脏 （dirty）页的数量 | +| BlockReadBytes_ram1 | 无 | ram1 块读取的字节数 | +| jemalloc.background_thread.run_intervals | 无 | jemalloc 后台线程的运行间隔数 | +| BlockQueueTime_nbd13 | 无 | nbd13 块队列等待时间 | +| jemalloc.background_thread.num_threads | 无 | jemalloc 后台线程的数量 | +| jemalloc.resident | 无 | jemalloc 分配器占用的物理内存大小（字节） | +| InterserverThreads | 无 | Interserver 线程数 | +| BlockWriteMerges_nbd7 | 无 | nbd7 块写合并数量 | +| MarkCacheBytes | 无 | StorageMergeTree 的 marks 的缓存大小 | +| MarkCacheFiles | 无 | StorageMergeTree 的 marks 的缓存文件数量 | +| MaxPartCountForPartition | 无 | partitions 中最大的活跃数据块的数量 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------------------------------- | ------ | ----------------------------------------- | -| AsynchronousMetricsCalculationTimeSpent | 无 | 异步指标计算花费的时间（秒） | -| jemalloc.arenas.all.muzzy_purged | 无 | 被清除的模糊（muzzy）页的数量 | -| jemalloc.arenas.all.dirty_purged | 无 | 被清除的脏 （dirty）页的数量 | -| BlockReadBytes_ram1 | 无 | ram1 块读取的字节数 | -| jemalloc.background_thread.run_intervals | 无 | jemalloc 后台线程的运行间隔数 | -| BlockQueueTime_nbd13 | 无 | nbd13 块队列等待时间 | -| jemalloc.background_thread.num_threads | 无 | jemalloc 后台线程的数量 | -| jemalloc.resident | 无 | jemalloc 分配器占用的物理内存大小（字节） | -| InterserverThreads | 无 | Interserver 线程数 | -| BlockWriteMerges_nbd7 | 无 | nbd7 块写合并数量 | -| MarkCacheBytes | 无 | StorageMergeTree 的 marks 的缓存大小 | -| MarkCacheFiles | 无 | StorageMergeTree 的 marks 的缓存文件数量 | -| MaxPartCountForPartition | 无 | partitions 中最大的活跃数据块的数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md index dcda89ee2b6..6b353bafd0b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md @@ -4,71 +4,67 @@ title: 监控：debian 系统监控 sidebar_label: Debian keywords: [开源监控系统, 操作系统监控, Debian监控] --- + > 对Debian系统的通用性能指标进行采集监控 ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- | ------------------------------------------------------------------------- | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Debian系统的ssh端口，默认: 22 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | -| 用户名 | 服务器用户名 | -| 密码 | 服务器密码 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -| 密钥 | 连接服务器所需密钥 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Debian系统的ssh端口，默认: 22 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | 服务器用户名 | +| 密码 | 服务器密码 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | ### 采集指标 #### 指标集合：系统基本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Host Name | 无 | 主机名称 | -| System Version | 无 | 操作系统版本 | -| Uptime | 无 | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | #### 指标集合：CPU 信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Info | 无 | 型号 | -| Cores | 无 | 核数 | -| Interrupt | 无 | 中断数 | -| Load | 无 | 负载 | -| Context Switch | 无 | 上下文切换 | -| Usage | % | 使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Info | 无 | 型号 | +| Cores | 无 | 核数 | +| Interrupt | 无 | 中断数 | +| Load | 无 | 负载 | +| Context Switch | 无 | 上下文切换 | +| Usage | % | 使用率 | #### 指标集合：内存信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------- | -------- | -------------- | -| Total Memory | Mb | 总内存容量 | -| User Program Memory | Mb | 用户程序内存量 | -| Free Memory | Mb | 空闲内存容量 | -| Buff Cache Memory | Mb | 缓存占用内存 | -| Available Memory | Mb | 剩余可用内存 | -| Memory Usage | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|---------| +| Total Memory | Mb | 总内存容量 | +| User Program Memory | Mb | 用户程序内存量 | +| Free Memory | Mb | 空闲内存容量 | +| Buff Cache Memory | Mb | 缓存占用内存 | +| Available Memory | Mb | 剩余可用内存 | +| Memory Usage | % | 内存使用率 | #### 指标集合：磁盘信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------- | -------- | ------------ | -| Disk Num | 无 | 磁盘总数 | -| Partition Num | 无 | 分区总数 | -| Block Write | 无 | 写磁盘块数 | -| Block Read | 无 | 读磁盘块数 | -| Write Rate | iops | 磁盘写速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|--------| +| Disk Num | 无 | 磁盘总数 | +| Partition Num | 无 | 分区总数 | +| Block Write | 无 | 写磁盘块数 | +| Block Read | 无 | 读磁盘块数 | +| Write Rate | iops | 磁盘写速率 | #### 指标集合：网卡信息 @@ -103,3 +99,4 @@ keywords: [开源监控系统, 操作系统监控, Debian监控] - 内存占用率：% - CPU占用率：% + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md index cdd9f6f6ee5..ea4a376c049 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md @@ -9,41 +9,41 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5236。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5236。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------------ | -| PORT_NUM | 无 | 数据库暴露服务端口 | -| CTL_PATH | 无 | 控制文件路径 | -| MAX_SESSIONS | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|-----------| +| PORT_NUM | 无 | 数据库暴露服务端口 | +| CTL_PATH | 无 | 控制文件路径 | +| MAX_SESSIONS | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------ | -| status$ | 无 | DM数据库的开闭状态 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|------------| +| status$ | 无 | DM数据库的开闭状态 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | ---------------------------------------------- | -| dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | -| dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | -| dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------------------------| +| dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | +| dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | +| dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md index 67ea72c177e..303ac47444f 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 @@ -13,24 +13,24 @@ keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | -|-----------|------------------------------------------------| -| DNS服务器IP | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：https://，http://）。 | -| 监控名称 | 标识此监控的名称，名称需要是唯一的。 | -| 端口 | DNS服务对外提供的端口，默认为53。 | -| 域名解析的地址 | 域名解析的地址。 | -| 连接超时时间 | 设置连接DNS服务器的超时时间，单位ms毫秒，默认6000毫秒。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------------------| +| DNS服务器IP | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：https://，http://）。 | +| 监控名称 | 标识此监控的名称，名称需要是唯一的。 | +| 端口 | DNS服务对外提供的端口，默认为53。 | +| 域名解析的地址 | 域名解析的地址。 | +| 连接超时时间 | 设置连接DNS服务器的超时时间，单位ms毫秒，默认6000毫秒。 | | 查询类别 | DNS查询的类别. 可选的值包括 `IN`， `CHAOS`， `HESIOD`， `NONE`， 和 `ANY`。默认值：IN | -| 是否使用tcp协议 | 设置DNS查询是否使用tcp协议。 | -| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒。 | -| 绑定标签 | 用于对监控资源进行分类管理。 | -| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息。 | +| 是否使用tcp协议 | 设置DNS查询是否使用tcp协议。 | +| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息。 | ### 采集指标 #### 指标集：Header -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|-----------------| | 响应时间 | 毫秒 | DNS服务器响应请求所需的时间 | | 操作码 | 无 | 当前消息的类型 | @@ -43,27 +43,31 @@ keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] ### 指标集: Question -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|-----------------------------------| | Section | 无 | 请求记录信息，其中包含查询的域名，资源类型，资源记录类，附加信息。 | ### 指标集: Answer -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|----------------------------------------| | Section0 | 无 | 请求响应信息，其中包含查询的域名，TTL，资源记录类，资源类型，查询的结果。 | + > Answer 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 ### 指标集: Authority -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|------------------------------------------------------------------| | Section0 | 无 | 域名的SOA（Start of Authority，权威区域起始）记录，其中包含查询的域名，TTL，资源类型，资源记录类等信息。 | + > Authority 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 ### 指标集: Additional -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|-------------| | Section0 | 无 | DNS查询的附加信息。 | + > Additional 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md index 221776b2426..c546b46fd2c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md @@ -7,7 +7,6 @@ keywords: [开源监控系统, 开源容器监控, Docker容器监控] > 对Docker容器的通用性能指标进行采集监控。 - ## 监控前操作 如果想要监控 `Docker` 中的容器信息，则需要按照一下步骤打开端口，让采集请求获取到对应的信息。 @@ -44,63 +43,60 @@ 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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 系统时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------------------------------| +| 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容器中的更新时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| 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使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|--------------------| +| 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/current/help/doris_fe.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md index 0e4803826be..10a66aa6853 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md @@ -15,118 +15,118 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |-----------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8030 , 取值自 `http_port` 配置项的值 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8030 , 取值自 `http_port` 配置项的值 | | 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认6000毫秒 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 绑定标签 | 您可以使用标签进行监控资源的分类管理， 例如给资源分别绑定生产环境、测试环境的标签。 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 绑定标签 | 您可以使用标签进行监控资源的分类管理， 例如给资源分别绑定生产环境、测试环境的标签。 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：doris_fe_connection_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------- | -| value | 无 | 当前FE的MySQL端口连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 当前FE的MySQL端口连接数 | #### 指标集合：doris_fe_edit_log_clean 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| success | 无 | 清理历史元数据日志成功的次数 | -| failed | 无 | 清理历史元数据日志失败的次数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| success | 无 | 清理历史元数据日志成功的次数 | +| failed | 无 | 清理历史元数据日志失败的次数 | #### 指标集合：doris_fe_edit_log -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------- | -------- | ------------------------ | -| write | 无 | 元数据日志写入次数的计数 | -| read | 无 | 元数据日志读取次数的计数 | -| current | 无 | 元数据日志当前数量 | -| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | -| current_bytes | 字节 | 元数据日志当前值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|--------------| +| write | 无 | 元数据日志写入次数的计数 | +| read | 无 | 元数据日志读取次数的计数 | +| current | 无 | 元数据日志当前数量 | +| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | +| current_bytes | 字节 | 元数据日志当前值 | #### 指标集合：doris_fe_image_clean 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------- | -| success | 无 | 清理历史元数据镜像文件成功的次数 | -| failed | 无 | 清理历史元数据镜像文件失败的次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|------------------| +| success | 无 | 清理历史元数据镜像文件成功的次数 | +| failed | 无 | 清理历史元数据镜像文件失败的次数 | #### 指标集合：doris_fe_image_write 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| success | 无 | 生成元数据镜像文件成功的次数 | -| failed | 无 | 生成元数据镜像文件失败的次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| success | 无 | 生成元数据镜像文件成功的次数 | +| failed | 无 | 生成元数据镜像文件失败的次数 | #### 指标集合：doris_fe_query_err -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------- | -| value | 无 | 错误查询的累积值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------| +| value | 无 | 错误查询的累积值 | #### 指标集合：doris_fe_max_journal_id -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------------------------------------------------------------------------------------| +| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | #### 指标集合：doris_fe_max_tablet_compaction_score -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------------------------------------------------| +| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | #### 指标集合：doris_fe_qps -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------ | -| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | #### 指标集合：doris_fe_query_err_rate -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------- | -| value | 无 | 每秒错误查询数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------| +| value | 无 | 每秒错误查询数 | #### 指标集合：doris_fe_report_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------------------------------| +| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | #### 指标集合：doris_fe_rps -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------------------------- | -| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------| +| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | #### 指标集合：doris_fe_scheduled_tablet_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------------------------------------------------------| +| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | #### 指标集合：doris_fe_txn_status 可以观测各个状态下导入事务的数量，来判断是否有堆积 -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------- | -| unknown | 无 | 未知 | -| prepare | 无 | 准备中 | -| committed | 无 | 已提交 | -| visible | 无 | 可见 | -| aborted | 无 | 已中止/已撤销 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| unknown | 无 | 未知 | +| prepare | 无 | 准备中 | +| committed | 无 | 已提交 | +| visible | 无 | 可见 | +| aborted | 无 | 已中止/已撤销 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md index e3e143c17ed..8c2f1e290e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md @@ -7,15 +7,15 @@ keywords: [开源监控系统, 开源中间件监控, DynamicTp线程池监控] > 对DynamicTp actuator 暴露的线程池性能指标进行采集监控。 -### 前提 +### 前提 -1. 集成使用 `DynamicTp` +1. 集成使用 `DynamicTp` `DynamicTp` 是Jvm语言的基于配置中心的轻量级动态线程池，内置监控告警功能，可通过SPI自定义扩展实现。 -集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) +集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) -2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 +2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 ```yaml management: @@ -24,7 +24,8 @@ management: exposure: include: '*' ``` -测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: + +测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: ```json [ @@ -58,45 +59,44 @@ management: ] ``` -3. 在HertzBeat中间件监控下添加DynamicTp监控即可 - +3. 在HertzBeat中间件监控下添加DynamicTp监控即可 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口，默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | - | Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 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 | 无 | 等待超时任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|--------------------------| +| 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/current/help/elasticsearch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md index e64d956bc77..a0b3082cc1a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -27,7 +27,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] #### 指标集合：health -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------------|------|----------| | cluster_name | 无 | 集群名称 | | status | 无 | 集群状态 | @@ -41,7 +41,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] #### 指标集合：nodes -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|--------| | total | 无 | 节点数 | | successful | 无 | 在线节点数 | @@ -49,7 +49,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] #### 指标集合：nodes_detail -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------------|------|---------| | node_name | 无 | 节点名称 | | ip | 无 | IP地址 | @@ -61,3 +61,4 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] | disk_free | GB | 磁盘剩余容量 | | disk_total | GB | 磁盘总容量 | | disk_used_percent | % | 磁盘使用率 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md index 258f7bb36dd..6c894671cc6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 无 | CPU内核数量 | @@ -47,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|----------| | total | Mb | 总内存容量 | | used | Mb | 用户程序内存量 | @@ -58,7 +58,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：磁盘信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|-----------| | disk_num | 无 | 磁盘总数 | | partition_num | 无 | 分区总数 | @@ -68,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：网卡信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | interface_name | 无 | 网卡名称 | | receive_bytes | Mb | 入站数据流量 | @@ -76,7 +76,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -88,7 +88,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -99,9 +99,10 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md index ef260f4dc2c..177c41874fb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源 Flink 监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -26,7 +26,7 @@ keywords: [开源监控系统, 开源 Flink 监控] #### 指标集合：overview -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|----------| | slots_total | 个 | 插槽总数 | | slots_used | 个 | 已用插槽数 | @@ -34,5 +34,3 @@ keywords: [开源监控系统, 开源 Flink 监控] | jobs_running | 个 | 正在运行的任务数 | | jobs_failed | 个 | 已经失败的任务数 | - - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md index da2ebd82cfb..a9baa1eeadd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md @@ -10,139 +10,135 @@ keywords: [开源监控系统, 开源 Flink On Yarn 监控] ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------------------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Yarn端口 | Yarn的端口，对应配置项:`yarn.resourcemanager.webapp.address`中的端口 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 启动SSL | 是否启用SSL | -| 用户名 | 连接用户名 | -| 密码 | 连接密码 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理。 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Yarn端口 | Yarn的端口，对应配置项:`yarn.resourcemanager.webapp.address`中的端口 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 启动SSL | 是否启用SSL | +| 用户名 | 连接用户名 | +| 密码 | 连接密码 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 | ### 采集指标 #### 指标集合：JobManager Metrics - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------------------------------------------- | -------- | ------------------ | -| Status.JVM.Memory.NonHeap.Committed | 字节 | 非堆内存的提交量 | -| Status.JVM.Memory.Mapped.TotalCapacity | 字节 | 映射内存的总容量 | -| Status.JVM.Memory.NonHeap.Used | 字节 | 非堆内存的使用量 | -| Status.JVM.Memory.Metaspace.Max | 字节 | 元空间的最大容量 | -| Status.JVM.GarbageCollector.G1_Old_Generation.Count | 字节 | 老年代垃圾收集次数 | -| Status.JVM.Memory.Direct.MemoryUsed | 字节 | 直接内存的使用量 | -| Status.JVM.Memory.Mapped.MemoryUsed | 字节 | 映射内存的使用量 | -| Status.JVM.GarbageCollector.G1_Young_Generation.Count | 字节 | 年轻代垃圾收集次数 | -| Status.JVM.Memory.Direct.TotalCapacity | 字节 | 直接内存的总容量 | -| Status.JVM.GarbageCollector.G1_Old_Generation.Time | 字节 | 老年代垃圾收集时间 | -| Status.JVM.Memory.Heap.Committed | 字节 | 堆内存的提交量 | -| Status.JVM.Memory.Mapped.Count | - | 映射内存的数量 | -| Status.JVM.Memory.Metaspace.Used | 字节 | 元空间的使用量 | -| Status.JVM.Memory.Direct.Count | - | 直接内存的数量 | -| Status.JVM.Memory.Heap.Used | 字节 | 堆内存的使用量 | -| Status.JVM.Memory.Heap.Max | 字节 | 堆内存的最大容量 | -| Status.JVM.GarbageCollector.G1_Young_Generation.Time | 字节 | 年轻代垃圾收集时间 | -| Status.JVM.Memory.NonHeap.Max | 字节 | 非堆内存的最大容量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------------------------------------|------|-----------| +| Status.JVM.Memory.NonHeap.Committed | 字节 | 非堆内存的提交量 | +| Status.JVM.Memory.Mapped.TotalCapacity | 字节 | 映射内存的总容量 | +| Status.JVM.Memory.NonHeap.Used | 字节 | 非堆内存的使用量 | +| Status.JVM.Memory.Metaspace.Max | 字节 | 元空间的最大容量 | +| Status.JVM.GarbageCollector.G1_Old_Generation.Count | 字节 | 老年代垃圾收集次数 | +| Status.JVM.Memory.Direct.MemoryUsed | 字节 | 直接内存的使用量 | +| Status.JVM.Memory.Mapped.MemoryUsed | 字节 | 映射内存的使用量 | +| Status.JVM.GarbageCollector.G1_Young_Generation.Count | 字节 | 年轻代垃圾收集次数 | +| Status.JVM.Memory.Direct.TotalCapacity | 字节 | 直接内存的总容量 | +| Status.JVM.GarbageCollector.G1_Old_Generation.Time | 字节 | 老年代垃圾收集时间 | +| Status.JVM.Memory.Heap.Committed | 字节 | 堆内存的提交量 | +| Status.JVM.Memory.Mapped.Count | - | 映射内存的数量 | +| Status.JVM.Memory.Metaspace.Used | 字节 | 元空间的使用量 | +| Status.JVM.Memory.Direct.Count | - | 直接内存的数量 | +| Status.JVM.Memory.Heap.Used | 字节 | 堆内存的使用量 | +| Status.JVM.Memory.Heap.Max | 字节 | 堆内存的最大容量 | +| Status.JVM.GarbageCollector.G1_Young_Generation.Time | 字节 | 年轻代垃圾收集时间 | +| Status.JVM.Memory.NonHeap.Max | 字节 | 非堆内存的最大容量 | #### 指标集合：JobManager Config - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------------------------ | -------- | ---------------------------- | -| internal.jobgraph-path | - | 内部作业图路径 | -| env.java.home | - | Java 环境路径 | -| classloader.check-leaked-classloader | - | 是否检查类加载器 | -| env.java.opts | - | Java 选项 | -| high-availability.cluster-id | - | 高可用性集群 ID | -| jobmanager.rpc.address | - | JobManager 的 RPC 地址 | -| jobmanager.memory.jvm-overhead.min | 字节 | JobManager 的 JVM 开销最小值 | -| jobmanager.web.port | 端口号 | JobManager 的 Web 端口 | -| webclient.port | 端口号 | Web 客户端端口 | -| execution.savepoint.ignore-unclaimed-state | - | 是否忽略未声明的状态 | -| io.tmp.dirs | 路径 | 临时文件目录 | -| parallelism.default | - | 默认并行度 | -| taskmanager.memory.fraction | - | TaskManager 内存占比 | -| taskmanager.numberOfTaskSlots | - | TaskManager 的任务槽数量 | -| yarn.application.name | - | Yarn 应用名称 | -| taskmanager.heap.mb | MB | TaskManager 堆内存大小 | -| taskmanager.memory.process.size | GB | TaskManager 进程内存大小 | -| web.port | 端口号 | Web 端口 | -| classloader.resolve-order | - | 类加载器解析顺序 | -| jobmanager.heap.mb | MB | JobManager 堆内存大小 | -| jobmanager.memory.off-heap.size | 字节 | JobManager 堆外内存大小 | -| state.backend.incremental | - | 状态后端是否增量 | -| execution.target | - | 执行目标 | -| jobmanager.memory.process.size | GB | JobManager 进程内存大小 | -| web.tmpdir | 路径 | Web 临时目录 | -| yarn.ship-files | 路径 | Yarn 传输文件 | -| jobmanager.rpc.port | 端口号 | JobManager 的 RPC 端口 | -| internal.io.tmpdirs.use-local-default | - | 是否使用本地默认临时目录 | -| execution.checkpointing.interval | 毫秒 | 检查点间隔 | -| execution.attached | - | 是否附加执行 | -| internal.cluster.execution-mode | - | 内部集群执行模式 | -| execution.shutdown-on-attached-exit | - | 是否在附加退出时关闭 | -| pipeline.jars | 路径 | 管道 JAR 文件 | -| rest.address | - | REST 地址 | -| state.backend | - | 状态后端类型 | -| jobmanager.memory.jvm-metaspace.size | 字节 | JobManager JVM 元空间大小 | -| $internal.deployment.config-dir | 路径 | 内部部署配置目录 | -| $internal.yarn.log-config-file | 路径 | 内部 Yarn 日志配置文件路径 | -| jobmanager.memory.heap.size | 字节 | JobManager 堆内存大小 | -| state.checkpoints.dir | 路径 | 状态检查点目录 | -| jobmanager.memory.jvm-overhead.max | 字节 | JobManager 的 JVM 开销最大值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------------------|------|------------------------| +| internal.jobgraph-path | - | 内部作业图路径 | +| env.java.home | - | Java 环境路径 | +| classloader.check-leaked-classloader | - | 是否检查类加载器 | +| env.java.opts | - | Java 选项 | +| high-availability.cluster-id | - | 高可用性集群 ID | +| jobmanager.rpc.address | - | JobManager 的 RPC 地址 | +| jobmanager.memory.jvm-overhead.min | 字节 | JobManager 的 JVM 开销最小值 | +| jobmanager.web.port | 端口号 | JobManager 的 Web 端口 | +| webclient.port | 端口号 | Web 客户端端口 | +| execution.savepoint.ignore-unclaimed-state | - | 是否忽略未声明的状态 | +| io.tmp.dirs | 路径 | 临时文件目录 | +| parallelism.default | - | 默认并行度 | +| taskmanager.memory.fraction | - | TaskManager 内存占比 | +| taskmanager.numberOfTaskSlots | - | TaskManager 的任务槽数量 | +| yarn.application.name | - | Yarn 应用名称 | +| taskmanager.heap.mb | MB | TaskManager 堆内存大小 | +| taskmanager.memory.process.size | GB | TaskManager 进程内存大小 | +| web.port | 端口号 | Web 端口 | +| classloader.resolve-order | - | 类加载器解析顺序 | +| jobmanager.heap.mb | MB | JobManager 堆内存大小 | +| jobmanager.memory.off-heap.size | 字节 | JobManager 堆外内存大小 | +| state.backend.incremental | - | 状态后端是否增量 | +| execution.target | - | 执行目标 | +| jobmanager.memory.process.size | GB | JobManager 进程内存大小 | +| web.tmpdir | 路径 | Web 临时目录 | +| yarn.ship-files | 路径 | Yarn 传输文件 | +| jobmanager.rpc.port | 端口号 | JobManager 的 RPC 端口 | +| internal.io.tmpdirs.use-local-default | - | 是否使用本地默认临时目录 | +| execution.checkpointing.interval | 毫秒 | 检查点间隔 | +| execution.attached | - | 是否附加执行 | +| internal.cluster.execution-mode | - | 内部集群执行模式 | +| execution.shutdown-on-attached-exit | - | 是否在附加退出时关闭 | +| pipeline.jars | 路径 | 管道 JAR 文件 | +| rest.address | - | REST 地址 | +| state.backend | - | 状态后端类型 | +| jobmanager.memory.jvm-metaspace.size | 字节 | JobManager JVM 元空间大小 | +| $internal.deployment.config-dir | 路径 | 内部部署配置目录 | +| $internal.yarn.log-config-file | 路径 | 内部 Yarn 日志配置文件路径 | +| jobmanager.memory.heap.size | 字节 | JobManager 堆内存大小 | +| state.checkpoints.dir | 路径 | 状态检查点目录 | +| jobmanager.memory.jvm-overhead.max | 字节 | JobManager 的 JVM 开销最大值 | #### TaskManager - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------------------- | -------- | ------------------------------------- | -| Container ID | - | 容器 ID，用于唯一标识一个容器 | -| Path | - | 容器路径 | -| Data Port | 端口号 | 数据传输端口 | -| JMX Port | 端口号 | JMX（Java Management Extensions）端口 | -| Last Heartbeat | 时间戳 | 最后一次心跳时间 | -| All Slots | 数量 | 容器中所有任务槽的数量 | -| Free Slots | 数量 | 容器中空闲任务槽的数量 | -| totalResourceCpuCores | 核心数 | 容器总的CPU核心数 | -| totalResourceTaskHeapMemory | MB | 容器总的任务堆内存大小 | -| totalResourceManagedMemory | MB | 容器总的托管内存大小 | -| totalResourceNetworkMemory | MB | 容器总的网络内存大小 | -| freeResourceCpuCores | 核心数 | 容器中空闲的CPU核心数 | -| freeResourceTaskHeapMemory | MB | 容器中空闲的任务堆内存大小 | -| freeResourceTaskOffHeapMemory | MB | 容器中空闲的任务堆外内存大小 | -| freeResourceManagedMemory | MB | 容器中空闲的托管内存大小 | -| freeResourceNetworkMemory | MB | 容器中空闲的网络内存大小 | -| CPU Cores | 核心数 | CPU核心数 | -| Physical MEM | MB | 物理内存大小 | -| JVM Heap Size | MB | JVM堆内存大小 | -| Flink Managed MEM | MB | Flink管理的内存大小 | -| Framework Heap | MB | 框架堆内存大小 | -| Task Heap | MB | 任务堆内存大小 | -| Framework Off-Heap | MB | 框架堆外内存大小 | -| memoryConfigurationTaskOffHeap | Byte | 任务堆外内存配置 | -| Network | MB | 网络内存配置 | -| Managed Memory | MB | 托管内存配置 | -| JVM Metaspace | MB | JVM元空间大小 | -| JVM Overhead | MB | JVM开销 | -| memoryConfigurationTotalFlinkMemory | Byte | Flink总内存配置 | -| memoryConfigurationTotalProcessMemory | Byte | 进程总内存配置 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------------|------|-----------------------------------| +| Container ID | - | 容器 ID，用于唯一标识一个容器 | +| Path | - | 容器路径 | +| Data Port | 端口号 | 数据传输端口 | +| JMX Port | 端口号 | JMX（Java Management Extensions）端口 | +| Last Heartbeat | 时间戳 | 最后一次心跳时间 | +| All Slots | 数量 | 容器中所有任务槽的数量 | +| Free Slots | 数量 | 容器中空闲任务槽的数量 | +| totalResourceCpuCores | 核心数 | 容器总的CPU核心数 | +| totalResourceTaskHeapMemory | MB | 容器总的任务堆内存大小 | +| totalResourceManagedMemory | MB | 容器总的托管内存大小 | +| totalResourceNetworkMemory | MB | 容器总的网络内存大小 | +| freeResourceCpuCores | 核心数 | 容器中空闲的CPU核心数 | +| freeResourceTaskHeapMemory | MB | 容器中空闲的任务堆内存大小 | +| freeResourceTaskOffHeapMemory | MB | 容器中空闲的任务堆外内存大小 | +| freeResourceManagedMemory | MB | 容器中空闲的托管内存大小 | +| freeResourceNetworkMemory | MB | 容器中空闲的网络内存大小 | +| CPU Cores | 核心数 | CPU核心数 | +| Physical MEM | MB | 物理内存大小 | +| JVM Heap Size | MB | JVM堆内存大小 | +| Flink Managed MEM | MB | Flink管理的内存大小 | +| Framework Heap | MB | 框架堆内存大小 | +| Task Heap | MB | 任务堆内存大小 | +| Framework Off-Heap | MB | 框架堆外内存大小 | +| memoryConfigurationTaskOffHeap | Byte | 任务堆外内存配置 | +| Network | MB | 网络内存配置 | +| Managed Memory | MB | 托管内存配置 | +| JVM Metaspace | MB | JVM元空间大小 | +| JVM Overhead | MB | JVM开销 | +| memoryConfigurationTotalFlinkMemory | Byte | Flink总内存配置 | +| memoryConfigurationTotalProcessMemory | Byte | 进程总内存配置 | #### TaskManager Metrics +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------------------|------|----------------------| +| Status.Shuffle.Netty.TotalMemory | MB | Netty Shuffle 使用的总内存 | +| Status.Flink.Memory.Managed.Used | MB | Flink 管理的已用内存 | +| Status.JVM.Memory.Metaspace.Used | MB | JVM 元空间已使用的内存 | +| Status.JVM.Memory.Metaspace.Max | MB | JVM 元空间的最大内存 | +| Status.JVM.Memory.Heap.Used | MB | JVM 堆内存已使用的内存 | +| Status.JVM.Memory.Heap.Max | MB | JVM 堆内存的最大容量 | +| Status.Flink.Memory.Managed.Total | MB | Flink 管理的内存总量 | +| Status.Shuffle.Netty.UsedMemory | MB | Netty Shuffle 使用的内存 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------------------- | -------- | -------------------------- | -| Status.Shuffle.Netty.TotalMemory | MB | Netty Shuffle 使用的总内存 | -| Status.Flink.Memory.Managed.Used | MB | Flink 管理的已用内存 | -| Status.JVM.Memory.Metaspace.Used | MB | JVM 元空间已使用的内存 | -| Status.JVM.Memory.Metaspace.Max | MB | JVM 元空间的最大内存 | -| Status.JVM.Memory.Heap.Used | MB | JVM 堆内存已使用的内存 | -| Status.JVM.Memory.Heap.Max | MB | JVM 堆内存的最大容量 | -| Status.Flink.Memory.Managed.Total | MB | Flink 管理的内存总量 | -| Status.Shuffle.Netty.UsedMemory | MB | Netty Shuffle 使用的内存 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md index 53f7eceb7c3..01313bd7ae6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md @@ -7,10 +7,9 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 > 对FreeBSD操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。 - ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -29,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -37,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 核数 | CPU内核数量 | @@ -48,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|---------| | physmem | Mb | 物理内存 | | usermem | Mb | 用户程序内存量 | @@ -57,7 +56,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -69,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -80,7 +79,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md index c86dfb14a7b..d421b6a78eb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md @@ -11,7 +11,7 @@ keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|--------------------------------------| | 目标Host | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：ftp://）。 | | 监控名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,8 @@ keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 #### 指标集合：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|------|------------------| | 活动状态 | 无 | 检查目录是否存在，且具有访问权限 | | 响应时间 | ms | 连接FTP响应时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md index f7fc4c150b7..9d39da7c9e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md @@ -7,29 +7,29 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] > 对网站的全部页面监测是否可用 > 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 -> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 +> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 网站地图 | 网站SiteMap地图地址的相对路径，例如：/sitemap.xml。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 监控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 | 无 | 请求此网站反馈的错误信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|-----------------| +| url | 无 | 网页的URL路径 | +| statusCode | 无 | 请求此网页的响应HTTP状态码 | +| responseTime | ms毫秒 | 网站响应时间 | +| errorMsg | 无 | 请求此网站反馈的错误信息 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md index 79c4ec85e52..48dc239b69a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md @@ -1,136 +1,134 @@ ---- -id: guide -title: 帮助中心 -sidebar_label: 帮助入门 ---- - -> 易用友好的实时监控工具，无需Agent，强大自定义监控能力。 -> 使用过程中的帮助文档,辅助信息。 - -## 🔬 监控服务 - -> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 -> 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 - -### 应用服务监控 - -  👉 [网站监测](website)
-  👉 [HTTP API](api)
-  👉 [PING连通性](ping)
-  👉 [端口可用性](port)
-  👉 [全站监控](fullsite)
-  👉 [SSL证书有效期](ssl_cert)
-  👉 [JVM虚拟机](jvm)
-  👉 [SpringBoot2.0](springboot2)
-  👉 [DNS服务器](dns)
-  👉 [FTP服务器](ftp)
-  👉 [Websocket](websocket)
- -### 应用程序监控 - - 👉 [Linux进程](process)
- 👉 [JVM虚拟机](jvm)
- 👉 [SpringBoot2.0](springboot2)
- 👉 [SpringBoot3.0](springboot3)
- 👉 [DynamicTp线程池](dynamic_tp)
- - -### 数据库监控 - -  👉 [MYSQL数据库监控](mysql)
-  👉 [MariaDB数据库监控](mariadb)
-  👉 [PostgreSQL数据库监控](postgresql)
-  👉 [SqlServer数据库监控](sqlserver)
-  👉 [Oracle数据库监控](oracle)
-  👉 [达梦数据库监控](dm)
-  👉 [OpenGauss数据库监控](opengauss)
-  👉 [IoTDB数据库监控](iotdb)
-  👉 [TiDB数据库监控](tidb)
-  👉 [MongoDB数据库监控](mongodb)
-  👉 [NebulaGraph集群监控](nebulagraph_cluster)
- -### 缓存监控 - - 👉 [Redis](redis)
- 👉 [Memcached](memcached)
- -### 操作系统监控 - -  👉 [Linux操作系统监控](linux)
-  👉 [Windows操作系统监控](windows)
-  👉 [Ubuntu操作系统监控](ubuntu)
-  👉 [Centos操作系统监控](centos)
-  👉 [FreeBSD操作系统监控](freebsd)
-  👉 [RedHat操作系统监控](redhat)
-  👉 [RockyLinux操作系统监控](rockylinux)
-  👉 [EulerOS操作系统监控](euleros)
- -### 中间件监控 - -  👉 [Zookeeper](zookeeper)
-  👉 [Kafka](kafka)
-  👉 [Tomcat](tomcat)
-  👉 [ShenYu](shenyu)
-  👉 [DynamicTp](dynamic_tp)
-  👉 [RabbitMQ](rabbitmq)
-  👉 [ActiveMQ](activemq)
-  👉 [Jetty](jetty)
-  👉 [Nacos](nacos)
- -### 云原生监控 - -  👉 [Docker](docker)
-  👉 [Kubernetes](kubernetes)
- -### 大数据监控 - -  👉 [Clickhouse](clickhouse)
-  👉 [ElasticSearch](elasticsearch)
-  👉 [Flink](flink)
- -### Ai大模型监控 - - 👉 [OpenAi](openai)
- -### 网络监控 - -  👉 [华为通用交换机](huawei_switch)
- -### 服务器监控 - -## 💡 告警服务 - -> 更自由化的阈值告警配置，支持邮箱，短信，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)
- -### 插件 - - 👉 [插件](plugin)
+--- +id: guide +title: 帮助中心 +sidebar_label: 帮助入门 +--- + +> 易用友好的实时监控工具，无需Agent，强大自定义监控能力。 +> 使用过程中的帮助文档,辅助信息。 + +## 🔬 监控服务 + +> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 +> 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 + +### 应用服务监控 + + 👉 [网站监测](website)
+ 👉 [HTTP API](api)
+ 👉 [PING连通性](ping)
+ 👉 [端口可用性](port)
+ 👉 [全站监控](fullsite)
+ 👉 [SSL证书有效期](ssl_cert)
+ 👉 [JVM虚拟机](jvm)
+ 👉 [SpringBoot2.0](springboot2)
+ 👉 [DNS服务器](dns)
+ 👉 [FTP服务器](ftp)
+ 👉 [Websocket](websocket)
+ +### 应用程序监控 + + 👉 [Linux进程](process)
+ 👉 [JVM虚拟机](jvm)
+ 👉 [SpringBoot2.0](springboot2)
+ 👉 [SpringBoot3.0](springboot3)
+ 👉 [DynamicTp线程池](dynamic_tp)
+ +### 数据库监控 + + 👉 [MYSQL数据库监控](mysql)
+ 👉 [MariaDB数据库监控](mariadb)
+ 👉 [PostgreSQL数据库监控](postgresql)
+ 👉 [SqlServer数据库监控](sqlserver)
+ 👉 [Oracle数据库监控](oracle)
+ 👉 [达梦数据库监控](dm)
+ 👉 [OpenGauss数据库监控](opengauss)
+ 👉 [IoTDB数据库监控](iotdb)
+ 👉 [TiDB数据库监控](tidb)
+ 👉 [MongoDB数据库监控](mongodb)
+ 👉 [NebulaGraph集群监控](nebulagraph_cluster)
+ +### 缓存监控 + + 👉 [Redis](redis)
+ 👉 [Memcached](memcached)
+ +### 操作系统监控 + + 👉 [Linux操作系统监控](linux)
+ 👉 [Windows操作系统监控](windows)
+ 👉 [Ubuntu操作系统监控](ubuntu)
+ 👉 [Centos操作系统监控](centos)
+ 👉 [FreeBSD操作系统监控](freebsd)
+ 👉 [RedHat操作系统监控](redhat)
+ 👉 [RockyLinux操作系统监控](rockylinux)
+ 👉 [EulerOS操作系统监控](euleros)
+ +### 中间件监控 + + 👉 [Zookeeper](zookeeper)
+ 👉 [Kafka](kafka)
+ 👉 [Tomcat](tomcat)
+ 👉 [ShenYu](shenyu)
+ 👉 [DynamicTp](dynamic_tp)
+ 👉 [RabbitMQ](rabbitmq)
+ 👉 [ActiveMQ](activemq)
+ 👉 [Jetty](jetty)
+ 👉 [Nacos](nacos)
+ +### 云原生监控 + + 👉 [Docker](docker)
+ 👉 [Kubernetes](kubernetes)
+ +### 大数据监控 + + 👉 [Clickhouse](clickhouse)
+ 👉 [ElasticSearch](elasticsearch)
+ 👉 [Flink](flink)
+ +### Ai大模型监控 + + 👉 [OpenAi](openai)
+ +### 网络监控 + + 👉 [华为通用交换机](huawei_switch)
+ +### 服务器监控 + +## 💡 告警服务 + +> 更自由化的阈值告警配置，支持邮箱，短信，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)
+ +### 插件 + + 👉 [插件](plugin)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md index fec361e2366..bda83b006e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md @@ -37,57 +37,54 @@ export HADOOP_OPTS= "$HADOOP_OPTS ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache (限JDK8及以下) -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md index f75d5cc8e98..e732bf45fd6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md @@ -4,6 +4,7 @@ title: 监控：Hbase Master监控 sidebar_label: Apache Hbase Master keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] --- + > 对Hbase Master的通用性能指标进行采集监控 **使用协议：HTTP** @@ -14,49 +15,46 @@ keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | -------------------------------------------------------------------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 端口 | hbase master的端口号，默认为16010。即:`hbase.master.info.port`参数值 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | hbase master的端口号，默认为16010。即:`hbase.master.info.port`参数值 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：server - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- |----| ---------------------------- | -| numRegionServers | 无 | 当前存活的 RegionServer 个数 | -| numDeadRegionServers | 无 | 当前Dead的 RegionServer 个数 | -| averageLoad | 无 | 集群平均负载 | -| clusterRequests | 无 | 集群请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|-------------------------| +| numRegionServers | 无 | 当前存活的 RegionServer 个数 | +| numDeadRegionServers | 无 | 当前Dead的 RegionServer 个数 | +| averageLoad | 无 | 集群平均负载 | +| clusterRequests | 无 | 集群请求数量 | #### 指标集合：Rit - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------- | ------ | ------------------- | -| ritCount | 无 | 当前的 RIT 数量 | -| ritCountOverThreshold | 无 | 超过阈值的 RIT 数量 | -| ritOldestAge | ms | 最老的RIT的持续时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|--------------| +| ritCount | 无 | 当前的 RIT 数量 | +| ritCountOverThreshold | 无 | 超过阈值的 RIT 数量 | +| ritOldestAge | ms | 最老的RIT的持续时间 | #### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------------- | ----- | ------------------------ | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|--------------------| | liveRegionServers | 无 | 当前活跃RegionServer列表 | | deadRegionServers | 无 | 当前离线RegionServer列表 | -| zookeeperQuorum | 无 | Zookeeper列表 | -| masterHostName | 无 | Master节点 | -| BalancerCluster_num_ops | 无 | 集群负载均衡次数 | -| numActiveHandler | 无 | RPC句柄数 | -| receivedBytes | MB | 集群接收数据量 | -| sentBytes | MB | 集群发送数据量(MB) | -| clusterRequests | 无 | 集群总请求数量 | +| zookeeperQuorum | 无 | Zookeeper列表 | +| masterHostName | 无 | Master节点 | +| BalancerCluster_num_ops | 无 | 集群负载均衡次数 | +| numActiveHandler | 无 | RPC句柄数 | +| receivedBytes | MB | 集群接收数据量 | +| sentBytes | MB | 集群发送数据量(MB) | +| clusterRequests | 无 | 集群总请求数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md index 44d5b533932..1c1cfdf1802 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md @@ -4,6 +4,7 @@ title: 监控 Hbase RegionServer监控 sidebar_label: Apache Hbase RegionServer keywords: [开源监控系统, 开源数据库监控, RegionServer监控] --- + > 对Hbase RegionServer的通用性能指标进行采集监控 **使用协议：HTTP** @@ -14,16 +15,15 @@ keywords: [开源监控系统, 开源数据库监控, RegionServer监控] ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ |----------------------------------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 端口 | hbase regionserver的端口号，默认为16030。即:`hbase.regionserver.info.port`参数值 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | hbase regionserver的端口号，默认为16030。即:`hbase.regionserver.info.port`参数值 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 @@ -31,67 +31,64 @@ keywords: [开源监控系统, 开源数据库监控, RegionServer监控] #### 指标集合：server - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- |-------|------------------------------------------| -| regionCount | 无 | Region数量 | -| readRequestCount | 无 | 重启集群后的读请求数量 | -| writeRequestCount | 无 | 重启集群后的写请求数量 | -| averageRegionSize | MB | 平均Region大小 | -| totalRequestCount | 无 | 全部请求数量 | -| ScanTime_num_ops | 无 | Scan 请求总量 | -| Append_num_ops | 无 | Append 请求量 | -| Increment_num_ops | 无 | Increment请求量 | -| Get_num_ops | 无 | Get 请求量 | -| Delete_num_ops | 无 | Delete 请求量 | -| Put_num_ops | 无 | Put 请求量 | -| ScanTime_mean | 无 | 平均 Scan 请求时间 | -| ScanTime_min | 无 | 最小 Scan 请求时间 | -| ScanTime_max | 无 | 最大 Scan 请求时间 | -| ScanSize_mean | bytes | 平均 Scan 请求大小 | -| ScanSize_min | 无 | 最小 Scan 请求大小 | -| ScanSize_max | 无 | 最大 Scan 请求大小 | -| slowPutCount | 无 | 慢操作次数/Put | -| slowGetCount | 无 | 慢操作次数/Get | -| slowAppendCount | 无 | 慢操作次数/Append | -| slowIncrementCount | 无 | 慢操作次数/Increment | -| slowDeleteCount | 无 | 慢操作次数/Delete | -| blockCacheSize | 无 | 缓存块内存占用大小 | -| blockCacheCount | 无 | 缓存块数量_Block Cache 中的 Block 数量 | -| blockCacheExpressHitPercent | 无 | 读缓存命中率 | -| memStoreSize | 无 | Memstore 大小 | -| FlushTime_num_ops | 无 | RS写磁盘次数/Memstore flush 写磁盘次数 | -| flushQueueLength | 无 | Region Flush 队列长度 | -| flushedCellsSize | 无 | flush到磁盘大小 | -| storeFileCount | 无 | Storefile 个数 | -| storeCount | 无 | Store 个数 | -| storeFileSize | 无 | Storefile 大小 | -| compactionQueueLength | 无 | Compaction 队列长度 | -| percentFilesLocal | 无 | Region 的 HFile 位于本地 HDFS Data Node的比例 | -| percentFilesLocalSecondaryRegions | 无 | Region 副本的 HFile 位于本地 HDFS Data Node的比例 | -| hlogFileCount | 无 | WAL 文件数量 | -| hlogFileSize | 无 | WAL 文件大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------------------|-------|-----------------------------------------| +| regionCount | 无 | Region数量 | +| readRequestCount | 无 | 重启集群后的读请求数量 | +| writeRequestCount | 无 | 重启集群后的写请求数量 | +| averageRegionSize | MB | 平均Region大小 | +| totalRequestCount | 无 | 全部请求数量 | +| ScanTime_num_ops | 无 | Scan 请求总量 | +| Append_num_ops | 无 | Append 请求量 | +| Increment_num_ops | 无 | Increment请求量 | +| Get_num_ops | 无 | Get 请求量 | +| Delete_num_ops | 无 | Delete 请求量 | +| Put_num_ops | 无 | Put 请求量 | +| ScanTime_mean | 无 | 平均 Scan 请求时间 | +| ScanTime_min | 无 | 最小 Scan 请求时间 | +| ScanTime_max | 无 | 最大 Scan 请求时间 | +| ScanSize_mean | bytes | 平均 Scan 请求大小 | +| ScanSize_min | 无 | 最小 Scan 请求大小 | +| ScanSize_max | 无 | 最大 Scan 请求大小 | +| slowPutCount | 无 | 慢操作次数/Put | +| slowGetCount | 无 | 慢操作次数/Get | +| slowAppendCount | 无 | 慢操作次数/Append | +| slowIncrementCount | 无 | 慢操作次数/Increment | +| slowDeleteCount | 无 | 慢操作次数/Delete | +| blockCacheSize | 无 | 缓存块内存占用大小 | +| blockCacheCount | 无 | 缓存块数量_Block Cache 中的 Block 数量 | +| blockCacheExpressHitPercent | 无 | 读缓存命中率 | +| memStoreSize | 无 | Memstore 大小 | +| FlushTime_num_ops | 无 | RS写磁盘次数/Memstore flush 写磁盘次数 | +| flushQueueLength | 无 | Region Flush 队列长度 | +| flushedCellsSize | 无 | flush到磁盘大小 | +| storeFileCount | 无 | Storefile 个数 | +| storeCount | 无 | Store 个数 | +| storeFileSize | 无 | Storefile 大小 | +| compactionQueueLength | 无 | Compaction 队列长度 | +| percentFilesLocal | 无 | Region 的 HFile 位于本地 HDFS Data Node的比例 | +| percentFilesLocalSecondaryRegions | 无 | Region 副本的 HFile 位于本地 HDFS Data Node的比例 | +| hlogFileCount | 无 | WAL 文件数量 | +| hlogFileSize | 无 | WAL 文件大小 | #### 指标集合：IPC - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------- | ------ | ------------------- | -| numActiveHandler | 无 | 当前的 RIT 数量 | -| NotServingRegionException | 无 | 超过阈值的 RIT 数量 | -| RegionMovedException | ms | 最老的RIT的持续时间 | -| RegionTooBusyException | ms | 最老的RIT的持续时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|--------------| +| numActiveHandler | 无 | 当前的 RIT 数量 | +| NotServingRegionException | 无 | 超过阈值的 RIT 数量 | +| RegionMovedException | ms | 最老的RIT的持续时间 | +| RegionTooBusyException | ms | 最老的RIT的持续时间 | #### 指标集合：JVM - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------------- | ----- | ------------------------ | -| MemNonHeapUsedM | 无 | 当前活跃RegionServer列表 | -| MemNonHeapCommittedM | 无 | 当前离线RegionServer列表 | -| MemHeapUsedM | 无 | Zookeeper列表 | -| MemHeapCommittedM | 无 | Master节点 | -| MemHeapMaxM | 无 | 集群负载均衡次数 | -| MemMaxM | 无 | RPC句柄数 | -| GcCount | MB | 集群接收数据量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|--------------------| +| MemNonHeapUsedM | 无 | 当前活跃RegionServer列表 | +| MemNonHeapCommittedM | 无 | 当前离线RegionServer列表 | +| MemHeapUsedM | 无 | Zookeeper列表 | +| MemHeapCommittedM | 无 | Master节点 | +| MemHeapMaxM | 无 | 集群负载均衡次数 | +| MemMaxM | 无 | RPC句柄数 | +| GcCount | MB | 集群接收数据量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md index efb05494290..db494acbb8e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md @@ -15,42 +15,43 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS DataN ## 配置参数 -| 参数名称 | 参数帮助描述 | -| ---------------- |---------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | -| 端口 | Apache HDFS DataNode 的监控端口号，默认为50075。 | -| 查询超时时间 | 查询 Apache HDFS DataNode 的超时时间，单位毫秒，默认6000毫秒。 | -| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | -| 是否探测 | 新增监控前是否先探测检查监控可用性。 | -| 描述备注 | 此监控的更多描述和备注信息。 | +| 参数名称 | 参数帮助描述 | +|--------|----------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | +| 端口 | Apache HDFS DataNode 的监控端口号，默认为50075。 | +| 查询超时时间 | 查询 Apache HDFS DataNode 的超时时间，单位毫秒，默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | +| 是否探测 | 新增监控前是否先探测检查监控可用性。 | +| 描述备注 | 此监控的更多描述和备注信息。 | ### 采集指标 #### 指标集合：FSDatasetState -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------------- | -------- | ------------------------------------ | -| DfsUsed | GB | DataNode HDFS使用量 | -| Remaining | GB | DataNode HDFS剩余空间 | -| Capacity | GB | DataNode HDFS空间总量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|-------------------| +| DfsUsed | GB | DataNode HDFS使用量 | +| Remaining | GB | DataNode HDFS剩余空间 | +| Capacity | GB | DataNode HDFS空间总量 | #### 指标集合：JvmMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------ | -------- | ------------------------------------ | -| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | -| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | -| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | -| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | -| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | -| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | -| ThreadsRunnable | 个 | 处于 RUNNABLE 状态的线程数量 | -| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | -| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | -| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|-------------------------------| +| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | +| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | +| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | +| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | +| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | +| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | +| ThreadsRunnable | 个 | 处于 RUNNABLE 状态的线程数量 | +| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | +| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | #### 指标集合：runtime -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------| -------- | ----------------- | -| StartTime | | 启动时间 | \ No newline at end of file +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| StartTime | | 启动时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md index 26fd5e985af..66343c11cd2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md @@ -15,79 +15,79 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS NameN ## 配置参数 -| 参数名称 | 参数帮助描述 | -| ---------------- |---------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | -| 端口 | HDFS NameNode 的监控端口号，默认为50070。 | -| 查询超时时间 | 查询 HDFS NameNode 的超时时间，单位毫秒，默认6000毫秒。 | -| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | -| 是否探测 | 新增监控前是否先探测检查监控可用性。 | -| 描述备注 | 此监控的更多描述和备注信息。 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | +| 端口 | HDFS NameNode 的监控端口号，默认为50070。 | +| 查询超时时间 | 查询 HDFS NameNode 的超时时间，单位毫秒，默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | +| 是否探测 | 新增监控前是否先探测检查监控可用性。 | +| 描述备注 | 此监控的更多描述和备注信息。 | ### 采集指标 #### 指标集合：FSNamesystem -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------------- | -------- | ------------------------------------ | -| CapacityTotal | | 集群存储总容量 | -| CapacityTotalGB | GB | 集群存储总容量 | -| CapacityUsed | | 集群存储已使用容量 | -| CapacityUsedGB | GB | 集群存储已使用容量 | -| CapacityRemaining | | 集群存储剩余容量 | -| CapacityRemainingGB | GB | 集群存储剩余容量 | -| CapacityUsedNonDFS | | 集群非 HDFS 使用容量 | -| TotalLoad | | 整个集群的客户端连接数 | -| FilesTotal | | 集群文件总数量 | -| BlocksTotal | | 总 BLOCK 数量 | -| PendingReplicationBlocks | | 等待被备份的块数量 | -| UnderReplicatedBlocks | | 副本数不够的块数量 | -| CorruptBlocks | | 坏块数量 | -| ScheduledReplicationBlocks | | 安排要备份的块数量 | -| PendingDeletionBlocks | | 等待被删除的块数量 | -| ExcessBlocks | | 多余的块数量 | -| PostponedMisreplicatedBlocks | | 被推迟处理的异常块数量 | -| NumLiveDataNodes | | 活的数据节点数量 | -| NumDeadDataNodes | | 已经标记为 Dead 状态的数据节点数量 | -| NumDecomLiveDataNodes | | 下线且 Live 的节点数量 | -| NumDecomDeadDataNodes | | 下线且 Dead 的节点数量 | -| NumDecommissioningDataNodes | | 正在下线的节点数量 | -| TransactionsSinceLastCheckpoint | | 从上次Checkpoint之后的事务数量 | -| LastCheckpointTime | | 上一次Checkpoint时间 | -| PendingDataNodeMessageCount | | DATANODE 的请求被 QUEUE 在 standby namenode 中的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|---------------------------------------------| +| CapacityTotal | | 集群存储总容量 | +| CapacityTotalGB | GB | 集群存储总容量 | +| CapacityUsed | | 集群存储已使用容量 | +| CapacityUsedGB | GB | 集群存储已使用容量 | +| CapacityRemaining | | 集群存储剩余容量 | +| CapacityRemainingGB | GB | 集群存储剩余容量 | +| CapacityUsedNonDFS | | 集群非 HDFS 使用容量 | +| TotalLoad | | 整个集群的客户端连接数 | +| FilesTotal | | 集群文件总数量 | +| BlocksTotal | | 总 BLOCK 数量 | +| PendingReplicationBlocks | | 等待被备份的块数量 | +| UnderReplicatedBlocks | | 副本数不够的块数量 | +| CorruptBlocks | | 坏块数量 | +| ScheduledReplicationBlocks | | 安排要备份的块数量 | +| PendingDeletionBlocks | | 等待被删除的块数量 | +| ExcessBlocks | | 多余的块数量 | +| PostponedMisreplicatedBlocks | | 被推迟处理的异常块数量 | +| NumLiveDataNodes | | 活的数据节点数量 | +| NumDeadDataNodes | | 已经标记为 Dead 状态的数据节点数量 | +| NumDecomLiveDataNodes | | 下线且 Live 的节点数量 | +| NumDecomDeadDataNodes | | 下线且 Dead 的节点数量 | +| NumDecommissioningDataNodes | | 正在下线的节点数量 | +| TransactionsSinceLastCheckpoint | | 从上次Checkpoint之后的事务数量 | +| LastCheckpointTime | | 上一次Checkpoint时间 | +| PendingDataNodeMessageCount | | DATANODE 的请求被 QUEUE 在 standby namenode 中的个数 | #### 指标集合：RPC -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------- | -------- | ---------------------- | -| ReceivedBytes | | 接收数据速率 | -| SentBytes | | 发送数据速率 | -| RpcQueueTimeNumOps | | RPC 调用速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|----------| +| ReceivedBytes | | 接收数据速率 | +| SentBytes | | 发送数据速率 | +| RpcQueueTimeNumOps | | RPC 调用速率 | #### 指标集合：runtime -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------| -------- | ----------------- | -| StartTime | | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| StartTime | | 启动时间 | #### 指标集合：JvmMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------ | -------- | ---------------- | -| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | -| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | -| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | -| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | -| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | -| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | -| GcCountParNew | 次 | 新生代GC消耗时间 | -| GcTimeMillisParNew | 毫秒 | 新生代GC消耗时间 | -| GcCountConcurrentMarkSweep | 毫秒 | 老年代GC次数 | -| GcTimeMillisConcurrentMarkSweep | 个 | 老年代GC消耗时间 | -| GcCount | 个 | GC次数 | -| GcTimeMillis | 个 | GC消耗时间 | -| ThreadsRunnable | 个 | 处于 BLOCKED 状态的线程数量 | -| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | -| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | -| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|-------------------------------| +| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | +| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | +| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | +| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | +| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | +| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | +| GcCountParNew | 次 | 新生代GC消耗时间 | +| GcTimeMillisParNew | 毫秒 | 新生代GC消耗时间 | +| GcCountConcurrentMarkSweep | 毫秒 | 老年代GC次数 | +| GcTimeMillisConcurrentMarkSweep | 个 | 老年代GC消耗时间 | +| GcCount | 个 | GC次数 | +| GcTimeMillis | 个 | GC消耗时间 | +| ThreadsRunnable | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | +| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md index 2c2136f91cf..3b41d3979c6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md @@ -16,6 +16,7 @@ keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hi ```shell hive --service metastore & ``` + **2. 启用 Hive Server2:** ```shell @@ -24,54 +25,53 @@ hive --service hiveserver2 & ### 配置参数 -| 参数名称 | 参数描述 | -| ---------- |--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 10002。 | -| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 参数名称 | 参数描述 | +|----------|--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 10002。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 #### 指标收集: 基本信息 -| 指标名称 | 指标单位 | 指标描述 | -|--------|-------|-----------------------------| -| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | -| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | -| 虚拟机版本 | 无 | 虚拟机的版本。 | -| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | +| 指标名称 | 指标单位 | 指标描述 | +|--------|------|-----------------------------| +| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | +| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | +| 虚拟机版本 | 无 | 虚拟机的版本。 | +| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | #### 指标收集: 环境信息 -| 指标名称 | 指标单位 | 指标描述 | -|------------|-------|--------------------------------| -| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | -| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | -| 操作系统版本 | 无 | 操作系统的版本。 | -| 操作系统架构 | 无 | 操作系统的架构。 | -| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | -| java运行环境版本 | 无 | Java 运行时环境的版本。 | +| 指标名称 | 指标单位 | 指标描述 | +|------------|------|--------------------------------| +| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | +| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | +| 操作系统版本 | 无 | 操作系统的版本。 | +| 操作系统架构 | 无 | 操作系统的架构。 | +| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | +| java运行环境版本 | 无 | Java 运行时环境的版本。 | #### 指标收集: 线程信息 -| 指标名称 | 指标单位 | 指标描述 | +| 指标名称 | 指标单位 | 指标描述 | |--------|------|------------------------------| | 线程数量 | None | HiveServer2 当前正在使用的线程数。 | -| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | +| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | | 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 | | 守护线程数 | None | HiveServer2 当前活动的守护线程数。 | #### 指标收集: 代码缓存 -| 指标名称 | 指标单位 | 指标描述 | -|------------|-------------|---------------| -| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | -| 内存池初始内存 | MB | 内存池请求的初始内存量。 | -| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | -| 内存池内存使用量 | MB | 内存池已使用内存量 | - +| 指标名称 | 指标单位 | 指标描述 | +|------------|------|---------------| +| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | +| 内存池初始内存 | MB | 内存池请求的初始内存量。 | +| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | +| 内存池内存使用量 | MB | 内存池已使用内存量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md index c30c4186661..6bd76f639e8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md @@ -1,53 +1,54 @@ ---- -id: huawei_switch -title: 监控：华为通用交换机 -sidebar_label: 华为通用交换机 -keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] ---- - -> 对 华为交换机 的通用指标(可用性，系统信息，端口流量等)进行采集监控。 - -**使用协议：SNMP** - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -|---------------------|-------------------------------------------------------------------------------------------------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | SNMP端口号，默认为161 | -| SNMP 版本 | 所使用的SNMP版本 | -| SNMP 团体字 | 用于SNMP v1 和 SNMP v2c，用于在SNMP Agent完成认证，字符串形式。团体名包括“read”和“write”两种，执行SNMP查询操作时，采用“read”团体名进行认证；执行SNMP设置操作时，则采用“write”团体名进行认证。 | -| SNMP username | 用于SNMP v3，MSG 用户名 | -| SNMP contextName | 用于SNMP v3，用于确定Context EngineID对被管理设备的MIB视图。 | -| SNMP authPassword | 用于SNMP v3，SNMP 认证密码 | -| authPassword 加密方式 | 用于SNMP v3，SNMP 认证算法 | -| SNMP privPassphrase | 用于SNMP v3，SNMP 加密密码 | -| privPassword 加密方式 | 用于SNMP v3，SNMP 加密算法 | -| 查询超时时间 | 设置查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | - -### 采集指标 - -由于华为通用交换机可查询的指标过多，详细的指标可于[华为MIB查询平台](https://info.support.huawei.com/info-finder/tool/zh/enterprise/mib) -进行查询。 - -此文档仅介绍监控模板中查询的监控指标。 - -#### 指标集合：huawei_core - -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ifIndex | 无 | 接口索引 该值大于零且全局唯一。 | -| ifDescr | 无 | 描述接口的字符串，应该包含制造商、产品名和接口软硬件的版本。 | -| ifMtu | octets | 最大传输单元。接口上可以传送的最大报文的大小。对于传输网络数据报的接口，这是接口可以传输的最大数据报的大小。 | -| ifSpeed | 比特/秒 | 估计的接口当前带宽。对于带宽无法改变或者无法准确估计的接口，该项为额定带宽值。 如果接口的带宽比该表项的值大，则该表项的值是其最大值（4,294,967,295），并且ifHighSpeed的值是接口的速率。对于没有速率概念的子层接口，该表项的值为零。 | -| ifInOctets | octets | 该接口入方向通过的总字节数，包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | -| ifInDiscards | 无 | 入方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文送往上层协议。 一个可能的原因是释放buffer的空间。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | -| ifInErrors | 无 | 出错而不会被送往上层协议的报文/传输单元个数。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | -| ifOutOctets | octets | 该接口出方向通过的总字节数，包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | -| ifOutDiscards | 无 | 出方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文发送。丢弃此类报文的一个可能原因是为了释放缓冲区空间。 在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | -| ifOutErrors | 无 | 对于面向数据包的接口，该节点表示由于错误而无法发送的数据包数量。对于面向字符或固定长度接口，该节点表示由于错误而无法传输的传输单元的数量。这种计数器的值可能在管理系统的重新初始化时会不连续，其他时间如ifCounterDiscontinuityTime的值。 | -| ifAdminStatus | 无 | 接口的理想状态。 testing（3）状态表示没有可操作的数据包通过。 当受管系统初始化时，全部接口开始于ifAdminStatus在down（2）状态。由于明确的管理动作或被管理的系统保留的每个配置信息，ifAdminStatus然后被更改为Up（1）或testing（3）状态（或保留在down（2）状态）。 | -| ifOperStatus | 无 | 当前接口的操作状态。testing(3)状态表示没有可操作的数据包可以通过。如果ifAdminStatus是down(2)，则ifOperStatus应该是down（2）。 如果ifAdminStatus是改为up（1），则ifOperStatus应该更改为up（1）。如果接口准备好传输，接收网络流量; 它应该改为dormant(5)。如果接口正在等待外部动作（如串行线路等待传入连接）; 它应该保持在down(2)状态，并且只有当有故障阻止它变成up(1)状态。 它应该留在notPresent（6）状态如果接口缺少（通常为硬件）组件。 | +--- +id: huawei_switch +title: 监控：华为通用交换机 +sidebar_label: 华为通用交换机 +keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] +--- + +> 对 华为交换机 的通用指标(可用性，系统信息，端口流量等)进行采集监控。 + +**使用协议：SNMP** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | SNMP端口号，默认为161 | +| SNMP 版本 | 所使用的SNMP版本 | +| SNMP 团体字 | 用于SNMP v1 和 SNMP v2c，用于在SNMP Agent完成认证，字符串形式。团体名包括“read”和“write”两种，执行SNMP查询操作时，采用“read”团体名进行认证；执行SNMP设置操作时，则采用“write”团体名进行认证。 | +| SNMP username | 用于SNMP v3，MSG 用户名 | +| SNMP contextName | 用于SNMP v3，用于确定Context EngineID对被管理设备的MIB视图。 | +| SNMP authPassword | 用于SNMP v3，SNMP 认证密码 | +| authPassword 加密方式 | 用于SNMP v3，SNMP 认证算法 | +| SNMP privPassphrase | 用于SNMP v3，SNMP 加密密码 | +| privPassword 加密方式 | 用于SNMP v3，SNMP 加密算法 | +| 查询超时时间 | 设置查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | + +### 采集指标 + +由于华为通用交换机可查询的指标过多，详细的指标可于[华为MIB查询平台](https://info.support.huawei.com/info-finder/tool/zh/enterprise/mib) +进行查询。 + +此文档仅介绍监控模板中查询的监控指标。 + +#### 指标集合：huawei_core + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ifIndex | 无 | 接口索引 该值大于零且全局唯一。 | +| ifDescr | 无 | 描述接口的字符串，应该包含制造商、产品名和接口软硬件的版本。 | +| ifMtu | octets | 最大传输单元。接口上可以传送的最大报文的大小。对于传输网络数据报的接口，这是接口可以传输的最大数据报的大小。 | +| ifSpeed | 比特/秒 | 估计的接口当前带宽。对于带宽无法改变或者无法准确估计的接口，该项为额定带宽值。 如果接口的带宽比该表项的值大，则该表项的值是其最大值（4,294,967,295），并且ifHighSpeed的值是接口的速率。对于没有速率概念的子层接口，该表项的值为零。 | +| ifInOctets | octets | 该接口入方向通过的总字节数，包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | +| ifInDiscards | 无 | 入方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文送往上层协议。 一个可能的原因是释放buffer的空间。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | +| ifInErrors | 无 | 出错而不会被送往上层协议的报文/传输单元个数。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | +| ifOutOctets | octets | 该接口出方向通过的总字节数，包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | +| ifOutDiscards | 无 | 出方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文发送。丢弃此类报文的一个可能原因是为了释放缓冲区空间。 在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | +| ifOutErrors | 无 | 对于面向数据包的接口，该节点表示由于错误而无法发送的数据包数量。对于面向字符或固定长度接口，该节点表示由于错误而无法传输的传输单元的数量。这种计数器的值可能在管理系统的重新初始化时会不连续，其他时间如ifCounterDiscontinuityTime的值。 | +| ifAdminStatus | 无 | 接口的理想状态。 testing（3）状态表示没有可操作的数据包通过。 当受管系统初始化时，全部接口开始于ifAdminStatus在down（2）状态。由于明确的管理动作或被管理的系统保留的每个配置信息，ifAdminStatus然后被更改为Up（1）或testing（3）状态（或保留在down（2）状态）。 | +| ifOperStatus | 无 | 当前接口的操作状态。testing(3)状态表示没有可操作的数据包可以通过。如果ifAdminStatus是down(2)，则ifOperStatus应该是down（2）。 如果ifAdminStatus是改为up（1），则ifOperStatus应该更改为up（1）。如果接口准备好传输，接收网络流量; 它应该改为dormant(5)。如果接口正在等待外部动作（如串行线路等待传入连接）; 它应该保持在down(2)状态，并且只有当有故障阻止它变成up(1)状态。 它应该留在notPresent（6）状态如果接口缺少（通常为硬件）组件。 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md index 8770ababdcd..bb802791dda 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md @@ -4,6 +4,7 @@ title: 监控：HugeGraph监控 sidebar_label: Apache HugeGraph keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] --- + > 对HugeGraph的通用性能指标进行采集监控 **使用协议：HTTP** @@ -14,8 +15,7 @@ keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] ## 配置参数 - -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-----------|---------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 端口 | HugeGraph restserver的端口号，默认为8080。即:`restserver_port`参数值 | @@ -30,117 +30,112 @@ keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] #### 指标集合：gauges -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------------------ | -------- | --------------------------------- | -| edge-hugegraph-capacity | 无 | 表示当前图中边的容量上限 | -| edge-hugegraph-expire | 无 | 表示边数据的过期时间 | -| edge-hugegraph-hits | 无 | 表示边数据缓存的命中次数 | -| edge-hugegraph-miss | 无 | 表示边数据缓存的未命中次数 | -| edge-hugegraph-size | 无 | 表示当前图中边的数量 | -| instances | 无 | 表示当前运行的HugeGraph实例数量| -| schema-id-hugegraph-capacity | 无 | 表示图中schema ID的容量上限 | -| schema-id-hugegraph-expire | 无 | 表示schema ID数据的过期时间 | -| schema-id-hugegraph-hits | 无 | 表示schema ID数据缓存的命中次数| -| schema-id-hugegraph-miss | 无 | 表示schema ID数据缓存的未命中次数| -| schema-id-hugegraph-size | 无 | 表示当前图中schema ID的数量 | -| schema-name-hugegraph-capacity | 无 | 表示图中schema名称的容量上限 | -| schema-name-hugegraph-expire | 无 | 表示schema名称数据的过期时间 | -| schema-name-hugegraph-hits | 无 | 表示schema名称数据缓存的命中次数| -| schema-name-hugegraph-miss | 无 | 表示schema名称数据缓存的未命中次数| -| schema-name-hugegraph-size | 无 | 表示当前图中schema名称的数量 | -| token-hugegraph-capacity | 无 | 表示图中token的容量上限 | -| token-hugegraph-expire | 无 | 表示token数据的过期时间 | -| token-hugegraph-hits | 无 | 表示token数据缓存的命中次数 | -| token-hugegraph-miss | 无 | 表示token数据缓存的未命中次数 | -| token-hugegraph-size | 无 | 表示当前图中token的数量 | -| users-hugegraph-capacity | 无 | 表示图中用户的容量上限 | -| users-hugegraph-expire | 无 | 表示用户数据的过期时间 | -| users-hugegraph-hits | 无 | 表示用户数据缓存的命中次数 | -| users-hugegraph-miss | 无 | 表示用户数据缓存的未命中次数 | -| users-hugegraph-size | 无 | 表示当前图中用户的数量 | -| users_pwd-hugegraph-capacity | 无 | 表示users_pwd的容量上限 | -| users_pwd-hugegraph-expire | 无 | 表示users_pwd数据的过期时间 | -| users_pwd-hugegraph-hits | 无 | 表示users_pwd数据缓存的命中次数 | -| users_pwd-hugegraph-miss | 无 | 表示users_pwd数据缓存的未命中次数| -| users_pwd-hugegraph-size | 无 | 表示当前图中users_pwd的数量 | -| vertex-hugegraph-capacity | 无 | 表示图中顶点的容量上限 | -| vertex-hugegraph-expire | 无 | 表示顶点数据的过期时间 | -| vertex-hugegraph-hits | 无 | 表示顶点数据缓存的命中次数 | -| vertex-hugegraph-miss | 无 | 表示顶点数据缓存的未命中次数 | -| vertex-hugegraph-size | 无 | 表示当前图中顶点的数量 | -| batch-write-threads | 无 | 表示批量写入操作时的线程数 | -| max-write-threads | 无 | 表示最大写入操作的线程数 | -| pending-tasks | 无 | 表示待处理的任务数 | -| workers | 无 | 表示当前工作线程的数量 | -| average-load-penalty | 无 | 表示平均加载延迟 | -| estimated-size | 无 | 表示估计的数据大小 | -| eviction-count | 无 | 表示被驱逐的数据条数 | -| eviction-weight | 无 | 表示被驱逐数据的权重 | -| hit-count | 无 | 表示缓存命中总数 | -| hit-rate | 无 | 表示缓存命中率 | -| load-count | 无 | 表示数据加载次数 | -| load-failure-count | 无 | 表示数据加载失败次数 | -| load-failure-rate | 无 | 表示数据加载失败率 | -| load-success-count | 无 | 表示数据加载成功次数 | -| long-run-compilation-count | 无 | 表示长时间运行的编译次数 | -| miss-count | 无 | 表示缓存未命中总数 | -| miss-rate | 无 | 表示缓存未命中率 | -| request-count | 无 | 表示总的请求次数 | -| total-load-time | 无 | 表示总的数据加载时间 | -| sessions | 无 | 表示当前的活动会话数量 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-----------------------| +| edge-hugegraph-capacity | 无 | 表示当前图中边的容量上限 | +| edge-hugegraph-expire | 无 | 表示边数据的过期时间 | +| edge-hugegraph-hits | 无 | 表示边数据缓存的命中次数 | +| edge-hugegraph-miss | 无 | 表示边数据缓存的未命中次数 | +| edge-hugegraph-size | 无 | 表示当前图中边的数量 | +| instances | 无 | 表示当前运行的HugeGraph实例数量 | +| schema-id-hugegraph-capacity | 无 | 表示图中schema ID的容量上限 | +| schema-id-hugegraph-expire | 无 | 表示schema ID数据的过期时间 | +| schema-id-hugegraph-hits | 无 | 表示schema ID数据缓存的命中次数 | +| schema-id-hugegraph-miss | 无 | 表示schema ID数据缓存的未命中次数 | +| schema-id-hugegraph-size | 无 | 表示当前图中schema ID的数量 | +| schema-name-hugegraph-capacity | 无 | 表示图中schema名称的容量上限 | +| schema-name-hugegraph-expire | 无 | 表示schema名称数据的过期时间 | +| schema-name-hugegraph-hits | 无 | 表示schema名称数据缓存的命中次数 | +| schema-name-hugegraph-miss | 无 | 表示schema名称数据缓存的未命中次数 | +| schema-name-hugegraph-size | 无 | 表示当前图中schema名称的数量 | +| token-hugegraph-capacity | 无 | 表示图中token的容量上限 | +| token-hugegraph-expire | 无 | 表示token数据的过期时间 | +| token-hugegraph-hits | 无 | 表示token数据缓存的命中次数 | +| token-hugegraph-miss | 无 | 表示token数据缓存的未命中次数 | +| token-hugegraph-size | 无 | 表示当前图中token的数量 | +| users-hugegraph-capacity | 无 | 表示图中用户的容量上限 | +| users-hugegraph-expire | 无 | 表示用户数据的过期时间 | +| users-hugegraph-hits | 无 | 表示用户数据缓存的命中次数 | +| users-hugegraph-miss | 无 | 表示用户数据缓存的未命中次数 | +| users-hugegraph-size | 无 | 表示当前图中用户的数量 | +| users_pwd-hugegraph-capacity | 无 | 表示users_pwd的容量上限 | +| users_pwd-hugegraph-expire | 无 | 表示users_pwd数据的过期时间 | +| users_pwd-hugegraph-hits | 无 | 表示users_pwd数据缓存的命中次数 | +| users_pwd-hugegraph-miss | 无 | 表示users_pwd数据缓存的未命中次数 | +| users_pwd-hugegraph-size | 无 | 表示当前图中users_pwd的数量 | +| vertex-hugegraph-capacity | 无 | 表示图中顶点的容量上限 | +| vertex-hugegraph-expire | 无 | 表示顶点数据的过期时间 | +| vertex-hugegraph-hits | 无 | 表示顶点数据缓存的命中次数 | +| vertex-hugegraph-miss | 无 | 表示顶点数据缓存的未命中次数 | +| vertex-hugegraph-size | 无 | 表示当前图中顶点的数量 | +| batch-write-threads | 无 | 表示批量写入操作时的线程数 | +| max-write-threads | 无 | 表示最大写入操作的线程数 | +| pending-tasks | 无 | 表示待处理的任务数 | +| workers | 无 | 表示当前工作线程的数量 | +| average-load-penalty | 无 | 表示平均加载延迟 | +| estimated-size | 无 | 表示估计的数据大小 | +| eviction-count | 无 | 表示被驱逐的数据条数 | +| eviction-weight | 无 | 表示被驱逐数据的权重 | +| hit-count | 无 | 表示缓存命中总数 | +| hit-rate | 无 | 表示缓存命中率 | +| load-count | 无 | 表示数据加载次数 | +| load-failure-count | 无 | 表示数据加载失败次数 | +| load-failure-rate | 无 | 表示数据加载失败率 | +| load-success-count | 无 | 表示数据加载成功次数 | +| long-run-compilation-count | 无 | 表示长时间运行的编译次数 | +| miss-count | 无 | 表示缓存未命中总数 | +| miss-rate | 无 | 表示缓存未命中率 | +| request-count | 无 | 表示总的请求次数 | +| total-load-time | 无 | 表示总的数据加载时间 | +| sessions | 无 | 表示当前的活动会话数量 | #### 指标集合：counters - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------------------------------- | -------- | ---------------------------------------- | -| GET-SUCCESS_COUNTER | 无 | 记录GET请求成功的次数 | -| GET-TOTAL_COUNTER | 无 | 记录GET请求的总次数 | -| favicon-ico-GET-FAILED_COUNTER | 无 | 记录获取favicon.ico失败的GET请求次数 | -| favicon-ico-GET-TOTAL_COUNTER | 无 | 记录获取favicon.ico的GET请求总次数 | -| graphs-HEAD-FAILED_COUNTER | 无 | 记录graphs资源的HEAD请求失败的次数 | -| graphs-HEAD-SUCCESS_COUNTER | 无 | 记录graphs资源的HEAD请求成功的次数 | -| graphs-HEAD-TOTAL_COUNTER | 无 | 记录graphs资源的HEAD请求的总次数 | -| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求成功的次数 | -| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求的总次数 | -| metircs-GET-FAILED_COUNTER | 无 | 记录获取metrics失败的GET请求次数 | -| metircs-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | -| metrics-GET-SUCCESS_COUNTER | 无 | 记录获取metrics成功的GET请求次数 | -| metrics-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | -| metrics-gauges-GET-SUCCESS_COUNTER | 无 | 记录获取metrics gauges成功的GET请求次数 | -| metrics-gauges-GET-TOTAL_COUNTER | 无 | 记录获取metrics gauges的GET请求总次数 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------------------------------------|------|------------------------------| +| GET-SUCCESS_COUNTER | 无 | 记录GET请求成功的次数 | +| GET-TOTAL_COUNTER | 无 | 记录GET请求的总次数 | +| favicon-ico-GET-FAILED_COUNTER | 无 | 记录获取favicon.ico失败的GET请求次数 | +| favicon-ico-GET-TOTAL_COUNTER | 无 | 记录获取favicon.ico的GET请求总次数 | +| graphs-HEAD-FAILED_COUNTER | 无 | 记录graphs资源的HEAD请求失败的次数 | +| graphs-HEAD-SUCCESS_COUNTER | 无 | 记录graphs资源的HEAD请求成功的次数 | +| graphs-HEAD-TOTAL_COUNTER | 无 | 记录graphs资源的HEAD请求的总次数 | +| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求成功的次数 | +| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求的总次数 | +| metircs-GET-FAILED_COUNTER | 无 | 记录获取metrics失败的GET请求次数 | +| metircs-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | +| metrics-GET-SUCCESS_COUNTER | 无 | 记录获取metrics成功的GET请求次数 | +| metrics-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | +| metrics-gauges-GET-SUCCESS_COUNTER | 无 | 记录获取metrics gauges成功的GET请求次数 | +| metrics-gauges-GET-TOTAL_COUNTER | 无 | 记录获取metrics gauges的GET请求总次数 | #### 指标集合：system +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------------------|------|--------------------------------| +| mem | 无 | 表示系统的总内存量 | +| mem_total | 无 | 表示系统的总内存量（与mem相同） | +| mem_used | 无 | 表示系统当前使用的内存量 | +| mem_free | 无 | 表示系统空闲的内存量 | +| mem_unit | 无 | 表示内存量的单位（如字节、千字节、兆字节等） | +| processors | 无 | 表示系统的处理器数量 | +| uptime | 无 | 表示系统运行时间，即从启动到现在的时间 | +| systemload_average | 无 | 表示系统的平均负载，反映了系统的繁忙程度 | +| heap_committed | 无 | 表示JVM堆内存的承诺大小，即保证可供JVM使用的堆内存大小 | +| heap_init | 无 | 表示JVM堆内存的初始大小 | +| heap_used | 无 | 表示JVM当前使用的堆内存大小 | +| heap_max | 无 | 表示JVM堆内存的最大可使用大小 | +| nonheap_committed | 无 | 表示JVM非堆内存的承诺大小 | +| nonheap_init | 无 | 表示JVM非堆内存的初始大小 | +| nonheap_used | 无 | 表示JVM当前使用的非堆内存大小 | +| nonheap_max | 无 | 表示JVM非堆内存的最大可使用大小 | +| thread_peak | 无 | 表示自JVM启动以来峰值线程数 | +| thread_daemon | 无 | 表示当前活跃的守护线程数 | +| thread_total_started | 无 | 表示自JVM启动以来总共启动过的线程数 | +| thread_count | 无 | 表示当前活跃的线程数 | +| garbage_collector_g1_young_generation_count | 无 | 表示G1垃圾收集器年轻代垃圾收集的次数 | +| garbage_collector_g1_young_generation_time | 无 | 表示G1垃圾收集器年轻代垃圾收集的总时间 | +| garbage_collector_g1_old_generation_count | 无 | 表示G1垃圾收集器老年代垃圾收集的次数 | +| garbage_collector_g1_old_generation_time | 无 | 表示G1垃圾收集器老年代垃圾收集的总时间 | +| garbage_collector_time_unit | 无 | 表示垃圾收集时间的单位（如毫秒、秒等） | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------------------------------- | -------- | -------------------------------------------------- | -| mem | 无 | 表示系统的总内存量 | -| mem_total | 无 | 表示系统的总内存量（与mem相同） | -| mem_used | 无 | 表示系统当前使用的内存量 | -| mem_free | 无 | 表示系统空闲的内存量 | -| mem_unit | 无 | 表示内存量的单位（如字节、千字节、兆字节等） | -| processors | 无 | 表示系统的处理器数量 | -| uptime | 无 | 表示系统运行时间，即从启动到现在的时间 | -| systemload_average | 无 | 表示系统的平均负载，反映了系统的繁忙程度 | -| heap_committed | 无 | 表示JVM堆内存的承诺大小，即保证可供JVM使用的堆内存大小 | -| heap_init | 无 | 表示JVM堆内存的初始大小 | -| heap_used | 无 | 表示JVM当前使用的堆内存大小 | -| heap_max | 无 | 表示JVM堆内存的最大可使用大小 | -| nonheap_committed | 无 | 表示JVM非堆内存的承诺大小 | -| nonheap_init | 无 | 表示JVM非堆内存的初始大小 | -| nonheap_used | 无 | 表示JVM当前使用的非堆内存大小 | -| nonheap_max | 无 | 表示JVM非堆内存的最大可使用大小 | -| thread_peak | 无 | 表示自JVM启动以来峰值线程数 | -| thread_daemon | 无 | 表示当前活跃的守护线程数 | -| thread_total_started | 无 | 表示自JVM启动以来总共启动过的线程数 | -| thread_count | 无 | 表示当前活跃的线程数 | -| garbage_collector_g1_young_generation_count | 无 | 表示G1垃圾收集器年轻代垃圾收集的次数 | -| garbage_collector_g1_young_generation_time | 无 | 表示G1垃圾收集器年轻代垃圾收集的总时间 | -| garbage_collector_g1_old_generation_count | 无 | 表示G1垃圾收集器老年代垃圾收集的次数 | -| garbage_collector_g1_old_generation_time | 无 | 表示G1垃圾收集器老年代垃圾收集的总时间 | -| garbage_collector_time_unit | 无 | 表示垃圾收集时间的单位（如毫秒、秒等） | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md index 4b04a003ed6..d913d0ff9f9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md @@ -5,7 +5,7 @@ sidebar_label: 邮箱信息监控 keywords: [开源监控系统, 开源网络监控, 邮箱信息监控] --- -> IMAP，即Internet Message Access Protocol（互联网邮件访问协议），您可以通过这种协议从邮件服务器上获取邮箱的详细信息 +> IMAP，即Internet Message Access Protocol（互联网邮件访问协议），您可以通过这种协议从邮件服务器上获取邮箱的详细信息 > 您可以点击`新建 QQ 邮箱监控`或`新建网易邮箱监控`并进行配置，或者选择`更多操作`，导入已有配置。 ### 启用 IMAP 服务 @@ -21,7 +21,7 @@ keywords: [开源监控系统, 开源网络监控, 邮箱信息监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |:----------|--------------------------------------------------| | 监控Host | IMAP 邮件服务器域名。注意⚠️不带协议头 (例如: https://, http://) 。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -40,8 +40,9 @@ keywords: [开源监控系统, 开源网络监控, 邮箱信息监控] #### 指标集合：（邮箱中文件夹名称） -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|---------------| | 邮件总数 | | 该文件夹下所有邮件数量 | | 最近收到邮件总数 | | 该文件夹下最近收到邮件数量 | | 未读邮件总数 | | 该文件夹下未读邮件数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md index 1881d79f4ee..00ff0b7f679 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md @@ -5,64 +5,62 @@ sidebar_label: InfluxDB 数据库 keywords: [开源监控系统, 开源数据库监控, InfluxDB 数据库监控] --- - ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为8086。 | -| URL | 数据库连接URL,一般是由host拼接，不需要添加 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为8086。 | +| URL | 数据库连接URL,一般是由host拼接，不需要添加 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：influxdb 基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------| ----------- |--------| -| build_date | 无 | 创建日期 | -| os | 无 | 操作系统 | -| cpus | 无 | cpus | -| version | 无 | 版本号 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|--------| +| build_date | 无 | 创建日期 | +| os | 无 | 操作系统 | +| cpus | 无 | cpus | +| version | 无 | 版本号 | #### 指标集合：http 响应时间 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|---------| | handler | 无 | handler | | path | 无 | 路径 | | response_code | 无 | 返回code | | method | 无 | 请求方法 | | user_agent | 无 | 用户代理 | -| status | 无 | 状态 | +| status | 无 | 状态 | #### 指标集合：正在排队的 TSM 数 -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------------|------|------------| -| bucket | 无 | 存储桶 | -| engine | 无 | 引擎类型 | -| id | 无 | 标识符 | -| level | 无 | 级别 | -| path | 无 | 数据文件路径 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| bucket | 无 | 存储桶 | +| engine | 无 | 引擎类型 | +| id | 无 | 标识符 | +| level | 无 | 级别 | +| path | 无 | 数据文件路径 | #### 指标集合：HTTP写入请求的字节数量 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------| -| endpoint | 无 | 终点 | -| org_id | 无 | 组织标识符 | -| status | 无 | 状态 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| endpoint | 无 | 终点 | +| org_id | 无 | 组织标识符 | +| status | 无 | 状态 | #### 指标集合：质量控制请求总数 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------| -| result | 无 | 结果 | -| org | 无 | 组织标识符 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| result | 无 | 结果 | +| org | 无 | 组织标识符 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md index ac56245fee4..97469a71932 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合：basic_influxdb_memstats_alloc -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合： influxdb_database_numMeasurements -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | job | 无 | 指标名称 | | instance | 无 | 指标所属实例 | @@ -46,7 +46,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合： influxdb_query_rate_seconds -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | @@ -54,10 +54,9 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合： influxdb_queryExecutor_queriesFinished_10s -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | | value | 无 | 指标值 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md index 0f0dc0e0ecb..fceb485f05b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md @@ -5,15 +5,15 @@ sidebar_label: IoTDB数据库 keywords: [开源监控系统, 开源数据库监控, IoTDB数据库监控] --- -> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 +> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 -## 监控前操作 +## 监控前操作 -您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 +您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 -开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) +开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) -主要如下步骤: +主要如下步骤: 1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server @@ -41,13 +41,13 @@ predefinedMetrics: - FILE ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 3. 在 HertzBeat 添加对应 IoTDB 监控即可。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -57,37 +57,37 @@ predefinedMetrics: | 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | | 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：cluster_node_status +#### 指标集合：cluster_node_status -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- |------|-------------------------| +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-------------------------| | name | 无 | 节点名称IP | | status | 无 | 节点状态，1=online 2=offline | #### 指标集合：jvm_memory_committed_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|------------------| | area | 无 | heap内存或nonheap内存 | | id | 无 | 内存区块 | -| value | MB | 当前向JVM申请的内存大小 | +| value | MB | 当前向JVM申请的内存大小 | #### 指标集合：jvm_memory_used_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| | area | 无 | heap内存或nonheap内存 | | id | 无 | 内存区块 | -| value | MB | JVM已使用内存大小 | +| value | MB | JVM已使用内存大小 | #### 指标集合：jvm_threads_states_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------| -| state | 无 | 线程状态 | -| count | 无 | 线程状态对应线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------| +| state | 无 | 线程状态 | +| count | 无 | 线程状态对应线程数量 | #### 指标集合：quantity 业务数据 @@ -99,22 +99,23 @@ predefinedMetrics: #### 指标集合：cache_hit 缓存 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------------------------------------------------| -| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | -| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------| +| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | +| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | #### 指标集合：queue 任务队列 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|---------------------------------------------------| -| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | -| status | 无 | 状态 running/waiting | -| value | 无 | 当前时间任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|----------------------------------------------| +| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | +| status | 无 | 状态 running/waiting | +| value | 无 | 当前时间任务数 | #### 指标集合：thrift_connections -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-------------| -| name | 无 | 名称 | -| connection | 无 | thrift当前连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|-------------| +| name | 无 | 名称 | +| connection | 无 | thrift当前连接数 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md index b7414f878b1..745a4f70a88 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md @@ -1,59 +1,66 @@ --- id: issue title: 常见问题 -sidebar_label: 常见问题 +sidebar_label: 常见问题 --- -### 监控常见问题 +### 监控常见问题 -1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** -> 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http +1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** -2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK ** -> 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在) +> 如信息所示，输入的监控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是可用的。 + 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address 4. 配置了k8s监控，但是实际监控时间并未按照正确间隔时间执行 -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：首先查看hertzbeat的错误日志，如果出现了'desc: SQL statement too long, check maxSQLLength config'，信息 > 二：需要调整tdengine配置文件，可在服务器创建taos.cfg文件，调整# max length of an SQL : maxSQLLength 654800，然后重启tdengine，需要加入配置文件的挂载 -> 三：如果遇到了重启tdengine失败，需要调整挂载数据文件中的配置，见 .../taosdata/dnode/dnodeEps.json，中dnodeFqdn调整为启动失败的dockerId即可，然后docker restart tdengine +> 三：如果遇到了重启tdengine失败，需要调整挂载数据文件中的配置，见 .../taosdata/dnode/dnodeEps.json，中dnodeFqdn调整为启动失败的dockerId即可，然后docker restart tdengine 5. 配置http api监控，用于进行业务接口探测，确保业务可以用，另外接口有进行token鉴权校验，"Authorization：Bearer eyJhbGciOiJIUzI1...."，配置后测试，提示“StatusCode 401”。服务端应用收到的token为"Authorization：Bearer%20eyJhbGciOiJIUzI1....",hertzbeat对空格进行转义为“%20”，服务器没有转义导致鉴权失败，建议转义功能作为可选项。 - -### Docker部署常见问题 +### Docker部署常见问题 1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** -此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + > 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` +> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` 2. **按照流程部署，访问 http://ip:1157/ 无界面** -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 -3. **日志报错TDengine连接或插入SQL失败** +3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter ### 安装包部署常见问题 1. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md index 04a15823529..b60a5882b9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md @@ -15,17 +15,18 @@ keywords: [开源监控系统, 开源中间件监控, Jetty应用服务器监控 #### Jetty应用服务器开启JMX协议步骤 -[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) +[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) -1. 在 Jetty 启动 JMX 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 端口等参数。 +命令执行成功会创建出 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件 + +2. 编辑 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件，修改 JMX 的 IP 端口等参数。 **`localhost` 需修改为对外暴露 IP** @@ -50,49 +51,45 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md index c97cc73b003..f046b3ef6a0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md @@ -28,57 +28,54 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache (限JDK8及以下) -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md index 2b4ed0514b7..3cb4d74132c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md @@ -7,7 +7,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] > 对Kafka的通用性能指标进行采集监控 -**使用协议：JMX** +**使用协议：JMX** ### 监控前操作 @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` -在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 +在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell export JMX_PORT=9999; @@ -32,71 +32,65 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：server_info -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Version | 无 | Kafka版本 | -| StartTimeMs | ms | 运行时间 | -| CommitId | 无 | 版本提交ID | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------| +| Version | 无 | Kafka版本 | +| StartTimeMs | ms | 运行时间 | +| CommitId | 无 | 版本提交ID | #### 指标集合：code_cache -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：active_controller_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 活跃监控器数量 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------| +| Value | 个 | 活跃监控器数量 | #### 指标集合：broker_partition_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 分区数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------| +| Value | 个 | 分区数量 | #### 指标集合：broker_leader_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 领导者数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------| +| Value | 个 | 领导者数量 | #### 指标集合：broker_handler_avg_percent 请求处理器空闲率 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| EventType | 无 | 类型 | -| RateUnit | 具体情况具体分析 | 单位 | -| Count | 个 | 数量 | -| OneMinuteRate | % | 一分钟处理率 | -| FiveMinuteRate | % | 五分钟处理率 | -| MeanRate | 无 | 平均处理率 | -| FifteenMinuteRate | 无 | 十五分钟处理率 | - - -> 其他指标见文知意，欢迎贡献一起优化文档。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|----------|---------| +| EventType | 无 | 类型 | +| RateUnit | 具体情况具体分析 | 单位 | +| Count | 个 | 数量 | +| OneMinuteRate | % | 一分钟处理率 | +| FiveMinuteRate | % | 五分钟处理率 | +| MeanRate | 无 | 平均处理率 | +| FifteenMinuteRate | 无 | 十五分钟处理率 | + +> 其他指标见文知意，欢迎贡献一起优化文档。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md index a0b0b625485..e0e5ecf7e50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md @@ -15,7 +15,7 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -34,7 +34,7 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL #### 指标集合：kafka_brokers -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | \_\_name__ | 无 | 指标名称 | | instance | 无 | 指标所属实例 | @@ -43,7 +43,7 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL #### 指标集合： kafka_topic_partitions -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | \_\_name__ | 无 | 指标名称 | | instance | 无 | 指标所属实例 | @@ -54,3 +54,4 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL 1. kafka启用了JMX监控，可以使用 [Kafka](kafka) 监控； 2. kafka集群部署kafka_exporter暴露的监控指标，可以参考 [Prometheus任务](prometheus) 配置Prometheus采集任务监控kafka。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md index f45da8d9b27..aa242d93a6b 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 @@ -7,14 +7,13 @@ keywords: [开源监控系统, 开源Kubernetes监控] > 对kubernetes的通用性能指标进行采集监控。 - ## 监控前操作 如果想要监控 `Kubernetes` 中的信息，则需要获取到可访问Api Server的授权TOKEN，让采集请求获取到对应的信息。 -参考获取token步骤 +参考获取token步骤 -#### 方式一: +#### 方式一: 1. 创建service account并绑定默认cluster-admin管理员集群角色 @@ -27,7 +26,9 @@ kubectl create clusterrolebinding dashboard-admin --clusterrole=cluster-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 @@ -36,13 +37,14 @@ kubectl create clusterrolebinding cluster-admin-manual --clusterrole=cluster-adm kubectl create token --duration=1000h cluster-admin ``` + ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| APiServer端口 | K8s APiServer端口，默认6443 | +| APiServer端口 | K8s APiServer端口，默认6443 | | token | 授权Access Token | | URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | | 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | @@ -53,44 +55,45 @@ kubectl create token --duration=1000h cluster-admin #### 指标集合：nodes -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- |--------| -| node_name | 无 | 节点名称 | -| is_ready | 无 | 节点状态 | -| capacity_cpu | 无 | CPU容量 | -| allocatable_cpu | 无 | 已分配CPU | -| capacity_memory | 无 | 内存容量 | -| allocatable_memory | 无 | 已分配内存 | -| creation_time | 无 | 节点创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------| +| node_name | 无 | 节点名称 | +| is_ready | 无 | 节点状态 | +| capacity_cpu | 无 | CPU容量 | +| allocatable_cpu | 无 | 已分配CPU | +| capacity_memory | 无 | 内存容量 | +| allocatable_memory | 无 | 已分配内存 | +| creation_time | 无 | 节点创建时间 | #### 指标集合：namespaces -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- |-------------| -| namespace | 无 | namespace名称 | -| status | 无 | 状态 | -| creation_time | 无 | 创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-------------| +| 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启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|----------------| +| 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 | 无 | 创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|--------------------------------------------------------| +| 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/current/help/linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md index 853be6610b4..4a69c04495e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md index 5986e109227..291c8eb8bf6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md @@ -15,49 +15,46 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|------------| +| version | 无 | 数据库版本 | +| port | 无 | 数据库暴露服务端口 | +| datadir | 无 | 数据库存储数据盘地址 | +| max_connections | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| threads_created | 无 | MariaDB已经创建的总连接数 | -| threads_connected | 无 | MariaDB已经连接的连接数 | -| threads_cached | 无 | MariaDB当前缓存的连接数 | -| threads_running | 无 | MariaDB当前活跃的连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|------------------| +| 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 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|-------------------------| +| 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/current/help/memcached.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md index 0debad01ce9..db88c1ac5fc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md @@ -34,7 +34,7 @@ STAT version 1.4.15 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------|---------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不带协议头（例如：https://，http://） | | 监控名称 | 标识此监控的名称。名称需要唯一 | @@ -47,7 +47,7 @@ STAT version 1.4.15 #### 指标集：server_info -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------------|------|-------------------| | pid | 无 | Memcache 服务器进程 ID | | uptime | s | 服务器已运行的秒数 | @@ -65,3 +65,4 @@ STAT version 1.4.15 | cmd_flush | 无 | Flush 命令请求数 | | get_misses | 无 | Get 命令未命中次数 | | delete_misses | 无 | Delete 命令未命中次数 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md index 23c4a866809..8c54174b54a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -27,7 +27,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：构建信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------------|------|-------------------------| | version | 无 | MongoDB版本信息 | | gitVersion | 无 | 源代码git版本 | @@ -39,7 +39,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：服务器文档 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|--------| | deleted | 无 | 已删除数 | | inserted | 无 | 已插入数 | @@ -48,21 +48,21 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：服务器操作 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|-------------------| | scanAndOrder | 无 | 执行查询时需要扫描并进行排序的次数 | | writeConflicts | 无 | 写冲突的次数 | #### 指标集合： 服务器_ttl -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------------|------|-------------------------------| | deletedDocuments | 无 | 删除的过期文档数量 | | passes | 无 | TTL清理过程的总传递次数，每次传递会检查并删除过期的文档 | #### 指标集合：系统信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-----------------------| | currentTime | 无 | 当前时间 | | hostname | 无 | 主机名 | @@ -75,7 +75,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：操作系统信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|--------| | type | 无 | 操作系统类型 | | name | 无 | 操作系统名称 | @@ -83,7 +83,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：额外信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------|------|----------------------| | versionString | 无 | 版本 | | libcVersion | 无 | 标准库版本 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md index c2d24ed8c22..01167c2fc7b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md @@ -4,79 +4,75 @@ title: 监控：MongoDB Atlas 数据库 sidebar_label: MongoDB Atlas 数据库 keywords: [ 开源监控系统, 开源数据库监控, MongoDB Atlas 数据库监控 ] --- + > 对MongoDB Atlas 数据库的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------------------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 用户名 | MongoDB用户名，可选。 | -| 密码 | MongoDB密码，可选。 | -| 数据库 | 数据库名称 | -| 认证数据库 | 存储用户凭据的数据库名称。 | -| 连接超时时间 | 设置连接MongoDB未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| 集群模式 | MongoDB Atlas集群取值为:mongodb-atlas | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 | -| 绑定标签 | 用于对监控资源进行分类管理。 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 用户名 | MongoDB用户名，可选。 | +| 密码 | MongoDB密码，可选。 | +| 数据库 | 数据库名称 | +| 认证数据库 | 存储用户凭据的数据库名称。 | +| 连接超时时间 | 设置连接MongoDB未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| 集群模式 | MongoDB Atlas集群取值为:mongodb-atlas | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 | ### 采集指标 #### 指标集合：构建信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------- | -------- | ----------------------------- | -| version | 无 | MongoDB版本信息 | -| gitVersion | 无 | 源代码git版本 | -| sysInfo | 无 | 系统信息 | -| allocator | 无 | MongoDB所使用的内存分配器 | -| javascriptEngine | 无 | MongoDB所使用的JavaScript引擎 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|-------------------------| +| version | 无 | MongoDB版本信息 | +| gitVersion | 无 | 源代码git版本 | +| sysInfo | 无 | 系统信息 | +| allocator | 无 | MongoDB所使用的内存分配器 | +| javascriptEngine | 无 | MongoDB所使用的JavaScript引擎 | #### 指标集合：服务器文档 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------- | -| delete | 无 | 已删除数 | -| insert | 无 | 已插入数 | -| update | 无 | 更新数 | -| query | 无 | 查询数 | -| getmore | 无 | 光标中剩余文档的请求数 | -| command | 无 | 执行命令操作的总数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|-------------| +| delete | 无 | 已删除数 | +| insert | 无 | 已插入数 | +| update | 无 | 更新数 | +| query | 无 | 查询数 | +| getmore | 无 | 光标中剩余文档的请求数 | +| command | 无 | 执行命令操作的总数 | #### 指标集合：网络操作 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | ---------------------------------- | -| Bytes In | 无 | 执行查询时需要扫描并进行排序的次数 | -| Bytes Out | 无 | 写冲突的次数 | -| Request Num | 无 | 请求数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|-------------------| +| Bytes In | 无 | 执行查询时需要扫描并进行排序的次数 | +| Bytes Out | 无 | 写冲突的次数 | +| Request Num | 无 | 请求数 | #### 指标集合： 连接信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------- | -------- | ------------------ | -| Current Connections | 无 | 当前正在进行连接数 | -| Available Connections | 无 | 可用连接数 | -| Total Created Connections | 无 | 创建的连接总数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|-----------| +| Current Connections | 无 | 当前正在进行连接数 | +| Available Connections | 无 | 可用连接数 | +| Total Created Connections | 无 | 创建的连接总数 | #### 指标集合：数据库统计 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|-------|----------| +| Database Name | 无 | 数据库名称 | +| Collections | 无 | 集合数 | +| Views | 无 | 视图数 | +| Objects | 无 | 文档数 | +| Document Avg Size | Bytes | 文档平均大小 | +| Document Size | Bytes | 文档大小 | +| Storage Size | Bytes | 使用存储空间大小 | +| Indexes | 无 | 索引数 | +| Index Size | Bytes | 索引大小 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------- | -------- | ---------------- | -| Database Name | 无 | 数据库名称 | -| Collections | 无 | 集合数 | -| Views | 无 | 视图数 | -| Objects | 无 | 文档数 | -| Document Avg Size | Bytes | 文档平均大小 | -| Document Size | Bytes | 文档大小 | -| Storage Size | Bytes | 使用存储空间大小 | -| Indexes | 无 | 索引数 | -| Index Size | Bytes | 索引大小 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md index 811cc2df135..4d47823d43b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md @@ -15,49 +15,46 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|------------| +| version | 无 | 数据库版本 | +| port | 无 | 数据库暴露服务端口 | +| datadir | 无 | 数据库存储数据盘地址 | +| max_connections | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| threads_created | 无 | MySql已经创建的总连接数 | -| threads_connected | 无 | MySql已经连接的连接数 | -| threads_cached | 无 | MySql当前缓存的连接数 | -| threads_running | 无 | MySql当前活跃的连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|----------------| +| 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 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|-------------------------| +| 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/current/help/nacos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md index ef643cf2fe3..84b432f4651 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md @@ -1,93 +1,95 @@ ---- -id: nacos -title: 监控：Nacos分布式监控 -sidebar_label: Nacos分布式 -keywords: [开源监控系统, 中间件监控, Nacos分布式监控] ---- - -> 通过调用 Nacos Metrics 接口对 Nacos 注册配置中心服务的通用指标进行采集监控。 - -### 监控前操作 - -#### 搭建Nacos集群暴露metrics数据 - -1. 按照[部署文档](https://nacos.io/zh-cn/docs/deployment.html)搭建好Nacos集群。 -2. 配置application.properties文件，暴露metrics数据。 -``` -management.endpoints.web.exposure.include=* -``` -3. 访问```{ip}:8848/nacos/actuator/prometheus```，查看是否能访问到metrics数据。 - -更多信息请参考[Nacos 监控手册](https://nacos.io/zh-cn/docs/monitor-guide.html)。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 服务器Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Nacos服务端口 | Nacos服务对外提供的端口，默认为8848。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -#### 指标集合：jvm - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| system_cpu_usage | 无 | CPU使用率 | -| system_load_average_1m | 无 | load | -| jvm_memory_used_bytes | 字节 | 内存使用字节，包含各种内存区 | -| jvm_memory_max_bytes | 字节 | 内存最大字节，包含各种内存区 | -| jvm_gc_pause_seconds_count | 无 | gc次数，包含各种gc | -| jvm_gc_pause_seconds_sum | 秒 | gc耗时，包含各种gc | -| jvm_threads_daemon | 无 | 线程数 | - -#### 指标集合：Nacos - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| http_server_requests_seconds_count | 秒 | http请求次数，包括多种(url,方法,code) | -| http_server_requests_seconds_sum | 秒 | http请求总耗时，包括多种(url,方法,code) | -| nacos_timer_seconds_sum | 秒 | Nacos config水平通知耗时 | -| nacos_timer_seconds_count | 无 | Nacos config水平通知次数 | -| nacos_monitor{name='longPolling'} | 无 | Nacos config长连接数 | -| nacos_monitor{name='configCount'} | 无 | Nacos config配置个数 | -| nacos_monitor{name='dumpTask'} | 无 | Nacos config配置落盘任务堆积数 | -| nacos_monitor{name='notifyTask'} | 无 | Nacos config配置水平通知任务堆积数 | -| nacos_monitor{name='getConfig'} | 无 | Nacos config读配置统计数 | -| nacos_monitor{name='publish'} | 无 | Nacos config写配置统计数 | -| nacos_monitor{name='ipCount'} | 无 | Nacos naming ip个数 | -| nacos_monitor{name='domCount'} | 无 | Nacos naming域名个数(1.x 版本) | -| nacos_monitor{name='serviceCount'} | 无 | Nacos naming域名个数(2.x 版本) | -| nacos_monitor{name='failedPush'} | 无 | Nacos naming推送失败数 | -| nacos_monitor{name='avgPushCost'} | 秒 | Nacos naming平均推送耗时 | -| nacos_monitor{name='leaderStatus'} | 无 | Nacos naming角色状态 | -| nacos_monitor{name='maxPushCost'} | 秒 | Nacos naming最大推送耗时 | -| nacos_monitor{name='mysqlhealthCheck'} | 无 | Nacos naming mysql健康检查次数 | -| nacos_monitor{name='httpHealthCheck'} | 无 | Nacos naming http健康检查次数 | -| nacos_monitor{name='tcpHealthCheck'} | 无 | Nacos naming tcp健康检查次数 | - -#### 指标集合：Nacos 异常 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| nacos_exception_total{name='db'} | 无 | 数据库异常 | -| nacos_exception_total{name='configNotify'} | 无 | Nacos config水平通知失败 | -| nacos_exception_total{name='unhealth'} | 无 | Nacos config server之间健康检查异常 | -| nacos_exception_total{name='disk'} | 无 | Nacos naming写磁盘异常 | -| nacos_exception_total{name='leaderSendBeatFailed'} | 无 | Nacos naming leader发送心跳异常 | -| nacos_exception_total{name='illegalArgument'} | 无 | 请求参数不合法 | -| nacos_exception_total{name='nacos'} | 无 | Nacos请求响应内部错误异常（读写失败，没权限，参数错误） | - -#### 指标集合：client - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| nacos_monitor{name='subServiceCount'} | 无 | 订阅的服务数 | -| nacos_monitor{name='pubServiceCount'} | 无 | 发布的服务数 | -| nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | -| nacos_client_request_seconds_count | 无 | 请求的次数，包括多种(url,方法,code) | -| nacos_client_request_seconds_sum | 秒 | 请求的总耗时，包括多种(url,方法,code) | - \ No newline at end of file +--- +id: nacos +title: 监控：Nacos分布式监控 +sidebar_label: Nacos分布式 +keywords: [开源监控系统, 中间件监控, Nacos分布式监控] +--- + +> 通过调用 Nacos Metrics 接口对 Nacos 注册配置中心服务的通用指标进行采集监控。 + +### 监控前操作 + +#### 搭建Nacos集群暴露metrics数据 + +1. 按照[部署文档](https://nacos.io/zh-cn/docs/deployment.html)搭建好Nacos集群。 +2. 配置application.properties文件，暴露metrics数据。 + +``` +management.endpoints.web.exposure.include=* +``` + +3. 访问```{ip}:8848/nacos/actuator/prometheus```，查看是否能访问到metrics数据。 + +更多信息请参考[Nacos 监控手册](https://nacos.io/zh-cn/docs/monitor-guide.html)。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 服务器Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Nacos服务端口 | Nacos服务对外提供的端口，默认为8848。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合：jvm + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------|------|----------------| +| system_cpu_usage | 无 | CPU使用率 | +| system_load_average_1m | 无 | load | +| jvm_memory_used_bytes | 字节 | 内存使用字节，包含各种内存区 | +| jvm_memory_max_bytes | 字节 | 内存最大字节，包含各种内存区 | +| jvm_gc_pause_seconds_count | 无 | gc次数，包含各种gc | +| jvm_gc_pause_seconds_sum | 秒 | gc耗时，包含各种gc | +| jvm_threads_daemon | 无 | 线程数 | + +#### 指标集合：Nacos + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------|------|-----------------------------| +| http_server_requests_seconds_count | 秒 | http请求次数，包括多种(url,方法,code) | +| http_server_requests_seconds_sum | 秒 | http请求总耗时，包括多种(url,方法,code) | +| nacos_timer_seconds_sum | 秒 | Nacos config水平通知耗时 | +| nacos_timer_seconds_count | 无 | Nacos config水平通知次数 | +| nacos_monitor{name='longPolling'} | 无 | Nacos config长连接数 | +| nacos_monitor{name='configCount'} | 无 | Nacos config配置个数 | +| nacos_monitor{name='dumpTask'} | 无 | Nacos config配置落盘任务堆积数 | +| nacos_monitor{name='notifyTask'} | 无 | Nacos config配置水平通知任务堆积数 | +| nacos_monitor{name='getConfig'} | 无 | Nacos config读配置统计数 | +| nacos_monitor{name='publish'} | 无 | Nacos config写配置统计数 | +| nacos_monitor{name='ipCount'} | 无 | Nacos naming ip个数 | +| nacos_monitor{name='domCount'} | 无 | Nacos naming域名个数(1.x 版本) | +| nacos_monitor{name='serviceCount'} | 无 | Nacos naming域名个数(2.x 版本) | +| nacos_monitor{name='failedPush'} | 无 | Nacos naming推送失败数 | +| nacos_monitor{name='avgPushCost'} | 秒 | Nacos naming平均推送耗时 | +| nacos_monitor{name='leaderStatus'} | 无 | Nacos naming角色状态 | +| nacos_monitor{name='maxPushCost'} | 秒 | Nacos naming最大推送耗时 | +| nacos_monitor{name='mysqlhealthCheck'} | 无 | Nacos naming mysql健康检查次数 | +| nacos_monitor{name='httpHealthCheck'} | 无 | Nacos naming http健康检查次数 | +| nacos_monitor{name='tcpHealthCheck'} | 无 | Nacos naming tcp健康检查次数 | + +#### 指标集合：Nacos 异常 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------------------|------|--------------------------------| +| nacos_exception_total{name='db'} | 无 | 数据库异常 | +| nacos_exception_total{name='configNotify'} | 无 | Nacos config水平通知失败 | +| nacos_exception_total{name='unhealth'} | 无 | Nacos config server之间健康检查异常 | +| nacos_exception_total{name='disk'} | 无 | Nacos naming写磁盘异常 | +| nacos_exception_total{name='leaderSendBeatFailed'} | 无 | Nacos naming leader发送心跳异常 | +| nacos_exception_total{name='illegalArgument'} | 无 | 请求参数不合法 | +| nacos_exception_total{name='nacos'} | 无 | Nacos请求响应内部错误异常（读写失败，没权限，参数错误） | + +#### 指标集合：client + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------|------|--------------------------| +| nacos_monitor{name='subServiceCount'} | 无 | 订阅的服务数 | +| nacos_monitor{name='pubServiceCount'} | 无 | 发布的服务数 | +| nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | +| nacos_client_request_seconds_count | 无 | 请求的次数，包括多种(url,方法,code) | +| nacos_client_request_seconds_sum | 秒 | 请求的总耗时，包括多种(url,方法,code) | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md index d070101da8f..ded4a06ad2f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md @@ -14,7 +14,7 @@ keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGr nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 ``` -### +### **1、通过 stats 和 rocksdb stats 接口获取可用参数。** @@ -34,7 +34,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-------------|--------------------------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️没有协议头（例如：https://、http://） | | 监控名称 | 识别此监控的名称。名称需要唯一 | @@ -53,7 +53,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 指标太多，相关链接如下 **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------------------------------------------|------|--------| | 达到内存水位线的语句的数量(rate) | | | | 达到内存水位线的语句的数量(sum) | | | @@ -116,8 +116,9 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 指标太多，相关链接如下 **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------|------|------------------------| | rocksdb.backup.read.bytes | | 备份 RocksDB 数据库期间读取的字节数 | | rocksdb.backup.write.bytes | | 指标名称 | | ... | | ... | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md index 851f6dd7946..252f5f47d8a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md @@ -11,7 +11,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -27,7 +27,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：基础信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|---------| | responseTime | 无 | 响应时间 | | charset | 无 | 字符集 | @@ -35,21 +35,21 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Session -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------------|------|------------| | session | 无 | session的数量 | | running_query_count | 无 | 正在执行的查询的数量 | #### 指标集合：后台任务 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------------| | queue_jobs | 无 | 等待中的后台任务 | | running_jobs | 无 | 正在执行的后台任务的数量 | #### 指标集合：节点信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------|------|-----------------| | total_storage_node | 无 | storage节点的数量 | | offline_storage_node | 无 | 离线的storage节点的数量 | @@ -60,7 +60,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Storage节点 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------------|------|---------------------| | host | 无 | 节点地址 | | port | 无 | 端口 | @@ -72,7 +72,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Meta节点 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|---------------------| | host | 无 | 节点地址 | | port | 无 | 端口 | @@ -81,7 +81,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Graph节点 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|---------------------| | host | 无 | 节点地址 | | port | 无 | 端口 | @@ -89,3 +89,4 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, | version | 无 | 版本 | > 如果需要自定义监控模板采集NebulaGraph集群的数据，请参考： [NGQL自定义监控](../advanced/extend-ngql.md) + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md index a509ff7da2a..82908df358b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md @@ -13,18 +13,19 @@ keywords: [开源监控工具, 开源Java监控工具, 监控Nginx指标] 如果你想使用这种监控方式监控 'Nginx' 的信息，你需要修改你的 Nginx 配置文件以启用监控模块。 -### 启用 ngx_http_stub_status_module +### 启用 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 并解压，在目录下执行 +下载 Nginx 并解压，在目录下执行 ```shell ./configure --prefix=/usr/local/nginx --with-http_stub_status_module @@ -58,7 +59,7 @@ nginx -s reload 5. 在浏览器访问 `http://localhost/nginx-status` 即可查看 Nginx 监控状态信息。 -### 启用 `ngx_http_reqstat_module` +### 启用 `ngx_http_reqstat_module` 1. 安装 `ngx_http_reqstat_module` 模块 @@ -107,49 +108,47 @@ nginx -s reload 4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 - **参考文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** **⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** ### 配置参数 -| 参数名 | 参数描述 | -|-------------------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | Nginx 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | +| 参数名 | 参数描述 | +|--------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | Nginx 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | ### 收集指标 #### 指标收集：nginx_status -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------------|------------| -| 接收连接数 | | 已接受的连接 | -| 处理连接数 | | 成功处理的连接 | -| 活动连接数 | | 当前活动连接 | -| 丢弃连接数 | | 丢弃的连接 | -| 请求连接数 | | 客户端请求 | -| 读连接数 | | 正在执行读操作的连接 | -| 写连接数 | | 正在执行写操作的连接 | -| 等待连接数 | | 等待连接 | +| 指标名称 | 指标单位 | 指标描述 | +|-------|------|------------| +| 接收连接数 | | 已接受的连接 | +| 处理连接数 | | 成功处理的连接 | +| 活动连接数 | | 当前活动连接 | +| 丢弃连接数 | | 丢弃的连接 | +| 请求连接数 | | 客户端请求 | +| 读连接数 | | 正在执行读操作的连接 | +| 写连接数 | | 正在执行写操作的连接 | +| 等待连接数 | | 等待连接 | #### 指标集：req_status -| 指标名称 | 指标单位 | 指标描述 | -|---------|-------|---------| -| 分组类别 | | 分组类别 | -| 分组名称 | | 分组名称 | -| 最大并发连接数 | | 最大并发连接数 | -| 最大带宽 | kb | 最大带宽 | -| 总流量 | kb | 总流量 | -| 总请求数 | | 总请求数 | -| 当前并发连接数 | | 当前并发连接数 | -| 当前带宽 | kb | 当前带宽 | - +| 指标名称 | 指标单位 | 指标描述 | +|---------|------|---------| +| 分组类别 | | 分组类别 | +| 分组名称 | | 分组名称 | +| 最大并发连接数 | | 最大并发连接数 | +| 最大带宽 | kb | 最大带宽 | +| 总流量 | kb | 总流量 | +| 总请求数 | | 总请求数 | +| 当前并发连接数 | | 当前并发连接数 | +| 当前带宽 | kb | 当前带宽 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md index 5760321922f..735ab741b4d 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 @@ -15,7 +15,7 @@ NTP监控的中文文档如下： ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------|--------------------------------------------------| | 监控主机 | 被监控的IPv4、IPv6或域名。注意⚠️不包含协议头（例如：https://，http://） | | 监控名称 | 标识此监控的名称。名称需要是唯一的 | @@ -27,7 +27,7 @@ NTP监控的中文文档如下： #### 指标集：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|------|--------------------------| | 响应时间 | 毫秒 | NTP服务器响应请求所需的时间。 | | 时间 | 毫秒 | NTP服务器报告的当前时间。 | @@ -39,3 +39,4 @@ NTP监控的中文文档如下： | 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 | | 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | | 精度 | | NTP服务器时钟的精度，表示其准确性。 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md index d22b1238855..0af3ca3d17b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md @@ -8,12 +8,13 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] ### 准备工作 #### 获取会话密钥 -> 1. 打开 Chrome 浏览器的网络请求界面 + +> 1. 打开 Chrome 浏览器的网络请求界面 > `Mac: cmd + option + i` > `Windows: ctrl + shift + i` > 2. 访问 https://platform.openai.com/usage > 3. 找到 https://api.openai.com/dashboard/billing/usage 请求 -> 4. 找到请求头中 Authorization 字段，并复制 `Bearer ` 之后的内容。例如： `sess-123456` +> 4. 找到请求头中 Authorization 字段，并复制 `Bearer ` 之后的内容。例如： `sess-123456` ### 注意事项 @@ -22,11 +23,11 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -|:-------|---------------------------------| +| 参数名称 | 参数帮助描述 | +|:-------|---------------------------------|---| | 监控Host | 此处填写 api.openai.com 。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | | -| 会话密钥 | 即准备工作中获取的会话密钥。 | | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | | +| 会话密钥 | 即准备工作中获取的会话密钥。 | | | 采集器 | 配置此监控使用哪台采集器调度采集。 | | 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 | | 绑定标签 | 对监控资源的分类管理标签。 | @@ -36,7 +37,7 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] #### 指标集合：信用额度授予 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|--------|---------| | 总授予额度 | 美元 ($) | 总授予额度 | | 总使用额度 | 美元 ($) | 总使用额度 | @@ -45,14 +46,14 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] #### 指标集合：模型花费 -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|--------|---------| -| 模型名称 | 无 | 模型名称 | -| 花费 | 美元 ($) | 花费 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|--------|--------| +| 模型名称 | 无 | 模型名称 | +| 花费 | 美元 ($) | 花费 | #### 指标集合：订阅计费 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|--------|--------------| | 是否有支付方式 | 无 | 是否有支付方式 | | 订阅是否已取消 | 无 | 订阅是否已取消 | @@ -80,3 +81,4 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] | 税务ID | 无 | 税务ID | | 结算地址 | 无 | 结算地址 | | 业务地址 | 无 | 业务地址 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md index 632a7f41b2d..8bf21d7debb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md @@ -9,50 +9,48 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| 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 | 无 | 这些统计信息上次被重置的时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | #### 指标集合：activity -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| running | 连接数 | 当前客户端连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md index 6c3b2e9ac7e..f32e2b070ae 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md @@ -4,114 +4,105 @@ title: 监控：OpenSUSE操作系统监控 sidebar_label: OpenSUSE操作系统 keywords: [开源监控系统, 开源操作系统监控, OpenSUSE操作系统监控] --- + > 对OpenSUSE操作系统的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- |------------------------------------------------------| +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | | 端口 | Linux SSH对外提供的端口，默认为22。 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次获取信息都会创建一个连接 | -| 用户名 | SSH连接用户名，可选 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次获取信息都会创建一个连接 | +| 用户名 | SSH连接用户名，可选 | | 密码 | SSH连接密码，可选 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | | 密钥 | 连接服务器所需密钥 | ### 采集指标 #### 指标集合：系统基本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Host Name | 无 | 主机名称 | -| System Version | 无 | 操作系统版本 | -| Uptime | 无 | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | #### 指标集合：CPU 信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | --------------------------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | #### 指标集合：内存信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------- | -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：磁盘信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------- | -------- | ------------------ | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：网卡信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- |------|-------------| -| interface_name | 无 | 网卡名称 | -| receive_bytes | Mb | 入站数据流量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Mb | 入站数据流量 | | transmit_bytes | Mb | 出站数据流量 | #### 指标集合：文件系统 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | -------------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | #### 指标集合：Top10 CPU进程 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| cpu_usage | % | CPU占用率 | -| mem_usage | % | 内存占用率 | -| command | 无 | 执行命令 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | #### 指标集合：Top10 内存进程 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| mem_usage | % | 内存占用率 | -| cpu_usage | % | CPU占用率 | -| command | 无 | 执行命令 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md index 2edf7bf6ff1..71f0db0bf95 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md @@ -15,55 +15,56 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1521。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 数据库状态 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|---------| +| database_version | 无 | 数据库版本 | +| database_type | 无 | 数据库类型 | +| hostname | 无 | 主机名称 | +| instance_name | 无 | 数据库实例名称 | +| startup_time | 无 | 数据库启动时间 | +| status | 无 | 数据库状态 | #### 指标集合：tablespace -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| file_id | 无 | 文件ID | -| file_name | 无 | 文件名称 | -| tablespace_name | 无 | 所属表空间名称 | -| status | 无 | 状态 | -| bytes | MB | 大小 | -| blocks | 无 | 区块数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------| +| file_id | 无 | 文件ID | +| file_name | 无 | 文件名称 | +| tablespace_name | 无 | 所属表空间名称 | +| status | 无 | 状态 | +| bytes | MB | 大小 | +| blocks | 无 | 区块数量 | #### 指标集合：user_connect -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| username | 无 | 用户名 | -| counts | 个数 | 当前连接数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| 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 兆字节数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|------|---------------------------------------| +| qps | QPS | I/O Requests per Second 每秒IO请求数量 | +| tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 | +| mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md index 7b6613f25bd..401e86f9382 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md @@ -5,32 +5,33 @@ sidebar_label: PING连通性 keywords: [开源监控系统, 开源网络监控, 网络PING监控] --- -> 对对端HOST地址进行PING操作，判断其连通性 +> 对对端HOST地址进行PING操作，判断其连通性 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | - -### 常见问题 +### 常见问题 1. 安装包部署的hertzbeat下ping连通性监控异常 - 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md index 2278530b47c..c4bf36a4cfb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md @@ -1,10 +1,11 @@ --- id: plugin title: 自定义插件 -sidebar_label: 自定义插件 +sidebar_label: 自定义插件 --- ## 自定义插件 + ### 简介 当前`Hertzbeat`在使用时，主要依赖`alert`模块对用户进行通知，然后用户采取一些措施如发送请求、执行`sql`、执行`shell`脚本等。 @@ -13,15 +14,19 @@ sidebar_label: 自定义插件 目前，`HertzBeat`只在告警后设置了触发`alert`方法，如需在采集、启动程序等时机设置触发方法，请在`https://github.com/apache/hertzbeat/issues/new/choose` 提`Task`。 ### 具体使用 + 1. 拉取主分支代码 `git clone https://github.com/apache/hertzbeat.git` ，定位到`plugin`模块的 `Plugin`接口。 - ![plugin-1.png](/img/docs/help/plugin-1.png) + ![plugin-1.png](/img/docs/help/plugin-1.png) 2. 在`org.apache.hertzbeat.plugin.impl`目录下, 新建一个接口实现类，如`org.apache.hertzbeat.plugin.impl.DemoPluginImpl`,在实现类中接收`Alert`类作为参数，实现`alert`方法，逻辑由用户自定义，这里我们简单打印一下对象。 - ![plugin-2.png](/img/docs/help/plugin-2.png) + ![plugin-2.png](/img/docs/help/plugin-2.png) 3. 在 `META-INF/services/org.apache.hertzbeat.plugin.Plugin` 文件中增加接口实现类的全限定名，每个实现类全限定名单独成行。 4. 打包`hertzbeat-plugin`模块。 - ![plugin-3.png](/img/docs/help/plugin-3.png) + ![plugin-3.png](/img/docs/help/plugin-3.png) + 5. 将打包后的`jar`包，拷贝到安装目录下的`ext-lib`目录下（若为`docker`安装则先将`ext-lib`目录挂载出来，再拷贝到该目录下） - ![plugin-4.png](/img/docs/help/plugin-4.png) + ![plugin-4.png](/img/docs/help/plugin-4.png) + 6. 然后重启`HertzBeat`，即可实现自定义告警后处理策略。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md index 8d6c2eb5548..4c58cc4a308 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md @@ -24,26 +24,24 @@ keywords: [开源监控工具，开源Java监控工具，监控POP3指标] 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 ``` - ### 配置参数 -| 参数名 | 参数描述 | -|-------------------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | POP3 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | +| 参数名 | 参数描述 | +|--------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | POP3 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | ### 采集指标 #### 指标集：email_status -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------| -| 邮件数量 | | 邮件数量 | -| 邮箱总大小 | kb | 邮箱中邮件的总大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------| +| 邮件数量 | | 邮件数量 | +| 邮箱总大小 | kb | 邮箱中邮件的总大小 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md index f27314e8e40..dd0b19aac82 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md @@ -9,22 +9,21 @@ keywords: [开源监控系统, 开源网络监控, TCP 端口可用性监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md index 4716d0e2e64..59adae7da81 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md @@ -9,50 +9,48 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| 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 | 无 | 这些统计信息上次被重置的时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | #### 指标集合：activity -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| running | 连接数 | 当前客户端连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md index 31ed6d64692..592e840b463 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md @@ -4,74 +4,72 @@ title: 监控：PrestoDB 数据库 sidebar_label: PrestoDB 数据库 keywords: [ 开源监控系统, 开源数据库监控, Presto数据库监控 ] --- + > 对PrestoDB Atlas 的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -|--------|---------------------------------------------| +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 被监控的平台端口。 | -| 连接超时时间 | 设置连接PrestoDB未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 | -| 绑定标签 | 用于对监控资源进行分类管理。 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 被监控的平台端口。 | +| 连接超时时间 | 设置连接PrestoDB未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息。 | ### 采集指标 #### 指标集合：集群状态 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------- | -------- | ----------------------------- | -| activeWorkers | 无 | 活跃节点数 | -| runningQueries | 无 | 运行中的查询数 | -| queuedQueries | 无 | 队列中的查询数 | -| blockedQueries | 无 | 阻塞的查询数 | -| runningDrivers | 无 | 运行中的驱动数 | -| runningTasks | 无 | 运行中的任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------| +| activeWorkers | 无 | 活跃节点数 | +| runningQueries | 无 | 运行中的查询数 | +| queuedQueries | 无 | 队列中的查询数 | +| blockedQueries | 无 | 阻塞的查询数 | +| runningDrivers | 无 | 运行中的驱动数 | +| runningTasks | 无 | 运行中的任务数 | #### 指标集合：节点信息 -| 指标名称 | 指标单位 | 指标帮助描述 | -|------|------| ---------------------------------- | -| uri | 无 | 节点链接 | -| recentRequests | 无 | 最近一段时间内的请求数量 | -| recentFailures | 无 | 最近一段时间内的失败请求数量 | -| recentSuccesses | 无 | 最近一段时间内的成功请求数量 | -| lastRequestTime | 无 | 最近一次请求的时间 | -| lastResponseTime | 无 | 最近一次响应的时间 | -| age | 无 | 持续时间 | -| recentFailureRatio | 无 | 最近一段时间内的失败 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|----------------| +| uri | 无 | 节点链接 | +| recentRequests | 无 | 最近一段时间内的请求数量 | +| recentFailures | 无 | 最近一段时间内的失败请求数量 | +| recentSuccesses | 无 | 最近一段时间内的成功请求数量 | +| lastRequestTime | 无 | 最近一次请求的时间 | +| lastResponseTime | 无 | 最近一次响应的时间 | +| age | 无 | 持续时间 | +| recentFailureRatio | 无 | 最近一段时间内的失败 | #### 指标集合：节点状态 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------| ---------------------------------- | -| nodeId | 无 | 节点ID | -| nodeVersion | 无 | 节点版本 | -| environment | 无 | 环境 | -| coordinator | 无 | 是否为协调节点 | -| uptime | 无 | 正常运行时间 | -| externalAddress | 无 | 外部地址 | -| internalAddress | 无 | 内部地址 | -| processors | 无 | 处理器数量 | -| processCpuLoad | 无 | 进程CPU负载 | -| systemCpuLoad | 无 | 系统CPU负载 | -| heapUsed | MB | 已使用堆内存 | -| heapAvailable | MB | 可用堆内存 | -| nonHeapUsed | MB | 请已使用非堆内存 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|----------| +| nodeId | 无 | 节点ID | +| nodeVersion | 无 | 节点版本 | +| environment | 无 | 环境 | +| coordinator | 无 | 是否为协调节点 | +| uptime | 无 | 正常运行时间 | +| externalAddress | 无 | 外部地址 | +| internalAddress | 无 | 内部地址 | +| processors | 无 | 处理器数量 | +| processCpuLoad | 无 | 进程CPU负载 | +| systemCpuLoad | 无 | 系统CPU负载 | +| heapUsed | MB | 已使用堆内存 | +| heapAvailable | MB | 可用堆内存 | +| nonHeapUsed | MB | 请已使用非堆内存 | #### 指标集合： 任务查询 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------- | -------- | ------------------ | -| taskId | 无 | 任务ID | -| version | 无 | 版本 | -| state | 无 | 状态 | -| self | 无 | 自身 | -| lastHeartbeat | 无 | 最后心跳时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|--------| +| taskId | 无 | 任务ID | +| version | 无 | 版本 | +| state | 无 | 状态 | +| self | 无 | 自身 | +| lastHeartbeat | 无 | 最后心跳时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md index 91d7718e419..2eda0726d27 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md @@ -4,48 +4,46 @@ title: 监控：Linux 进程监控 sidebar_label: Process keywords: [开源监控系统, 操作系统进程监控, 进程监控] --- + > 对Linux系统进程基础信息进行采集监控，包括进程的 CPU使用率、内存使用率、物理内存、IO 等监控 ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- | ------------------------------------------------------------------------- | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux系统的ssh端口，默认: 22 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | -| 用户名 | 服务器用户名 | -| 密码 | 服务器密码 | -| 进程名称 | 需要监控的进程名称或进程部分名称 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -| 私钥 | 连接服务器所需私钥 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux系统的ssh端口，默认: 22 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | 服务器用户名 | +| 密码 | 服务器密码 | +| 进程名称 | 需要监控的进程名称或进程部分名称 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 私钥 | 连接服务器所需私钥 | ### 采集指标 #### 指标集合：进程基本信息 - | 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------ | -| PID | 无 | 进程ID | -| User | 无 | 用户 | -| CPU | 无 | CPU使用率 | -| MEM | 无 | 内存使用率 | -| rss | 无 | 物理内存 | -| cmd | 无 | 运行命令 | +|------|------|--------| +| PID | 无 | 进程ID | +| User | 无 | 用户 | +| CPU | 无 | CPU使用率 | +| MEM | 无 | 内存使用率 | +| rss | 无 | 物理内存 | +| cmd | 无 | 运行命令 | #### 指标集合：内存使用信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------ | -| PID | 无 | 进程ID | -| detail | 无 | 详细监控指标 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| PID | 无 | 进程ID | +| detail | 无 | 详细监控指标 | 包含的指标： @@ -63,22 +61,20 @@ keywords: [开源监控系统, 操作系统进程监控, 进程监控] #### 指标集合：其他监控信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------ | -| PID | 无 | 进程ID | -| path | 无 | 执行路径 | -| date | 无 | 启动时间 | -| fd_count | 无 | 打开文件描述符数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-----------| +| PID | 无 | 进程ID | +| path | 无 | 执行路径 | +| date | 无 | 启动时间 | +| fd_count | 无 | 打开文件描述符数量 | #### 指标集合：IO - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------ | -| PID | 无 | 进程ID | -| metric | 无 | 监控指标名称 | -| value | 无 | 监控指标值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| PID | 无 | 进程ID | +| metric | 无 | 监控指标名称 | +| value | 无 | 监控指标值 | 包含的指标： @@ -89,3 +85,4 @@ keywords: [开源监控系统, 操作系统进程监控, 进程监控] - read_bytes(进程从磁盘实际读取的字节数) - write_bytes(进程写入到磁盘的实际字节数) - cancelled_write_bytes(进程写入到磁盘的实际字节数) + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md index 50d148f72a9..571da45aac0 100755 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, Prometheus协议监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(例如: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -40,5 +40,3 @@ keywords: [ 开源监控系统, Prometheus协议监控 ] 其余设置保持默认。 - - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md index a59178686b3..1c12244997b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md @@ -4,52 +4,48 @@ title: 监控：Pulsar监控 sidebar_label: Apache Pulsar keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] --- + > 对Pulsar的通用性能指标进行采集监控 **使用协议：HTTP** ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------------------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 端口 | Pulsar的webServiceProt值，默认为8080。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | Pulsar的webServiceProt值，默认为8080。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：版本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------ | -| Version Info | 无 | 版本信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| Version Info | 无 | 版本信息 | #### 指标集合：process_start_time_seconds - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- | ------------ | -| Process Start Time | 无 | 进程启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------| +| Process Start Time | 无 | 进程启动时间 | #### 指标集合：process_open_fds - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------- | -------- | ---------------- | -| Open File Descriptors | 无 | 打开的文件描述符 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| Open File Descriptors | 无 | 打开的文件描述符 | #### 指标集合：process_max_fds - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | -------------- | -| Max File Descriptors | 无 | 最大文件描述符 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|---------| +| Max File Descriptors | 无 | 最大文件描述符 | #### 指标集合： jvm_memory_pool_allocated_bytes diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md index 8cb91eeb3e6..89c728162c9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md @@ -5,42 +5,42 @@ sidebar_label: RabbitMQ消息中间件 keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间件监控] --- -> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 +> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 -### 监控前操作 +### 监控前操作 > HertzBeat 使用 RabbitMQ Management 的 Rest Api 对 RabbitMQ 进行指标数据采集。 -> 故需要您的 RabbitMQ 环境开启 Management 插件 +> 故需要您的 RabbitMQ 环境开启 Management 插件 -1. 开启 Management 插件，或使用自开启版本 +1. 开启 Management 插件，或使用自开启版本 ```shell rabbitmq-plugins enable rabbitmq_management ``` -2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 +2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -|----------|---------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | -| 用户名 | 接口Basic认证时使用的用户名 | -| 密码 | 接口Basic认证时使用的密码 | -| 超时时间 | HTTP请求查询超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | +| 用户名 | 接口Basic认证时使用的用户名 | +| 密码 | 接口Basic认证时使用的密码 | +| 超时时间 | HTTP请求查询超时时间 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：overview +#### 指标集合：overview -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------------|------|--------------------------| | product_version | 无 | 产品版本 | | product_name | 无 | 产品名称 | @@ -52,7 +52,7 @@ rabbitmq-plugins enable rabbitmq_management #### 指标集合：object_totals -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-----------------| | channels | 无 | channels的总数量 | | connections | 无 | connections的总数量 | @@ -62,65 +62,65 @@ rabbitmq-plugins enable rabbitmq_management #### 指标集合：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 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|-------------------------------| +| 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. | +| 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. | +| 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 | +| vhost | 无 | vhost path | | auto_delete | 无 | Whether the queue will be deleted automatically when no longer used | -| policy | 无 | Effective policy name for the queue. | +| 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_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_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 | 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_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md index 5ceb911c8d3..e0b8ae48cf4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 无 | CPU内核数量 | @@ -47,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|----------| | total | Mb | 总内存容量 | | used | Mb | 用户程序内存量 | @@ -58,7 +58,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：磁盘信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|-----------| | disk_num | 无 | 磁盘总数 | | partition_num | 无 | 分区总数 | @@ -68,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：网卡信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | interface_name | 无 | 网卡名称 | | receive_bytes | Mb | 入站数据流量 | @@ -76,7 +76,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -88,7 +88,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -99,9 +99,10 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md index dd9b304e1ce..58248fb0b45 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md @@ -2,244 +2,239 @@ id: redis title: 监控：REDIS数据库监控 sidebar_label: REDIS数据库 -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] --- > 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|-----------------------------------------------| +| 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 | 无 | 客户端超时表中的客户端数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|--------------------------------------------------------------------------------| +| 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 | 无 | 已延迟释放的对象数。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|----------|-----------------------------------------------------------------------------------------------| +| 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操作期间写入时复制内存的字节大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|--------|-----------------------------------------------------------------------------------------------------| +| 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 | 无 | 正在写入的线程数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|----------------------------------------------------| +| 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的大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-------------------------------------------------------------------------------------| +| 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 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|------------------------| +| 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 | 无 | | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-----------| +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | #### 指标集合：cluster -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------------------| +| 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命令的统计信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------------------------------------------------------------------------------------------------------------------------| +| 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/current/help/redis_cluster.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md index 48858be3e86..ed684ef1a35 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md @@ -19,10 +19,10 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 appendonly yes bind 0.0.0.0 protected-mode no - + ``` - *docker-compose.yml* + *docker-compose.yml* ```yml services: @@ -34,7 +34,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 - ./redis.conf:/usr/local/etc/redis/redis.conf ports: - "1000:6379" - + redis-master-2: image: redis:latest container_name: redis-master-2 @@ -43,7 +43,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 - ./redis.conf:/usr/local/etc/redis/redis.conf ports: - "2000:6379" - + redis-master-3: image: redis:latest container_name: redis-master-3 @@ -52,7 +52,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 - ./redis.conf:/usr/local/etc/redis/redis.conf ports: - "3000:6379" - + redis-slave-1: image: redis:latest container_name: redis-slave-1 @@ -61,7 +61,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 - ./redis.conf:/usr/local/etc/redis/redis.conf ports: - "1001:6379" - + redis-slave-2: image: redis:latest container_name: redis-slave-2 @@ -70,7 +70,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 - ./redis.conf:/usr/local/etc/redis/redis.conf ports: - "2001:6379" - + redis-slave-3: image: redis:latest container_name: redis-slave-3 @@ -79,60 +79,59 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 - ./redis.conf:/usr/local/etc/redis/redis.conf ports: - "3001:6379" - + networks: default: external: name: hertzbeat-redis-cluster ``` - 2. 查看所有容器的 IP 地址，搭建 Redis 集群时需要用到这些. - ```bash - docker-compose up -d - docker network inspect hertzbeat-redis-cluste - ``` - - ``` - "Containers": { - "187b879f73c473b3cbb82ff95f668e65af46115ddaa27f3ff1a712332b981531": { - ... - "Name": "redis-slave-2", - "IPv4Address": "192.168.117.6/24", - ... - }, - "45e22b64c82e51857fc104436cdd6cc0c5776ad10a2e4b9d8e52e36cfb87217e": { - ... - "Name": "redis-master-3", - "IPv4Address": "192.168.117.3/24 - ... - }, - "57838ae37956f8af181f9a131eb011efec332b9ed3d49480f59d8962ececf288": { - ... - "Name": "redis-master-2", - "IPv4Address": "192.168.117.7/24", - ... - }, - "94478d14bd950bcde533134870beb89b392515843027a0595af56dd1e3305a76": { - ... - "Name": "redis-master-1", - "IPv4Address": "192.168.117.4/24", - ... - }, - "ad055720747e7fc430ba794d5321723740eeb345c280073e4292ed4302ff657c": { - ... - "Name": "redis-slave-3", - "IPv4Address": "192.168.117.2/24", - ... - }, - "eddded1ac4c7528640ba0c6befbdaa48faa7cb13905b934ca1f5c69ab364c725": { - ... - "Name": "redis-slave-1", - "IPv4Address": "192.168.117.5/24", - ... - } - }, - ``` + ```bash + docker-compose up -d + docker network inspect hertzbeat-redis-cluste + ``` + + ``` + "Containers": { + "187b879f73c473b3cbb82ff95f668e65af46115ddaa27f3ff1a712332b981531": { + ... + "Name": "redis-slave-2", + "IPv4Address": "192.168.117.6/24", + ... + }, + "45e22b64c82e51857fc104436cdd6cc0c5776ad10a2e4b9d8e52e36cfb87217e": { + ... + "Name": "redis-master-3", + "IPv4Address": "192.168.117.3/24 + ... + }, + "57838ae37956f8af181f9a131eb011efec332b9ed3d49480f59d8962ececf288": { + ... + "Name": "redis-master-2", + "IPv4Address": "192.168.117.7/24", + ... + }, + "94478d14bd950bcde533134870beb89b392515843027a0595af56dd1e3305a76": { + ... + "Name": "redis-master-1", + "IPv4Address": "192.168.117.4/24", + ... + }, + "ad055720747e7fc430ba794d5321723740eeb345c280073e4292ed4302ff657c": { + ... + "Name": "redis-slave-3", + "IPv4Address": "192.168.117.2/24", + ... + }, + "eddded1ac4c7528640ba0c6befbdaa48faa7cb13905b934ca1f5c69ab364c725": { + ... + "Name": "redis-slave-1", + "IPv4Address": "192.168.117.5/24", + ... + } + }, + ``` 3. 进入容器, 然后构建集群. ```bash @@ -162,3 +161,4 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 ### Configuration Parameters 查看 [REDIS](https://hertzbeat.apache.org/docs/help/redis) 文档. + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md index f12a43628ac..84cc24fc976 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-----------|------------------------------------------------| | 注册中心Host | RocketMQ注册中心的IPV4,IPV6(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -24,7 +24,7 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 #### 指标集合：集群 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------------------|------|------------| | BrokerId | 无 | Broker唯一ID | | Address | 无 | Broker地址 | @@ -38,7 +38,7 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 #### 指标集合：消费者 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------|------|--------| | Consumer_group | 无 | 消费者组 | | Client_quantity | 无 | 客户端数量 | @@ -46,3 +46,4 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 | Consume_type | 无 | 消费类型 | | Consume_tps | 无 | 消费TPS | | Delay | 无 | 延迟 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md index 0cf541702bc..55923468da8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 无 | CPU内核数量 | @@ -47,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|----------| | total | Mb | 总内存容量 | | used | Mb | 用户程序内存量 | @@ -58,7 +58,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：磁盘信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|-----------| | disk_num | 无 | 磁盘总数 | | partition_num | 无 | 分区总数 | @@ -68,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：网卡信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | interface_name | 无 | 网卡名称 | | receive_bytes | Mb | 入站数据流量 | @@ -76,7 +76,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -88,7 +88,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -99,9 +99,10 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md index 08788efeaae..1149ed4bdd9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md @@ -5,24 +5,24 @@ sidebar_label: ShenYu网关监控 keywords: [开源监控系统, 开源消息中间件监控, ShenYu网关监控监控] --- -> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 +> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 -## 监控前操作 +## 监控前操作 -您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 +您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 -开启插件, 参考 [官方文档](https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin) +开启插件, 参考 [官方文档](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} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` 2. 在网关的配置yaml文件中编辑如下内容： @@ -39,11 +39,11 @@ shenyu: jvm_enabled: true #开启jvm的监控指标 ``` -最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 +最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -53,79 +53,78 @@ shenyu: | 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | | 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：shenyu_request_total +#### 指标集合：shenyu_request_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-------------------| -| value | 无 | 收集ShenYu网关的所有请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | 收集ShenYu网关的所有请求数量 | #### 指标集合：shenyu_request_throw_created -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------------------| -| value | 无 | 收集ShenYu网关的异常请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | 收集ShenYu网关的异常请求数量 | #### 指标集合：process_cpu_seconds_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| value | 无 | 用户和系统CPU总计所用的秒数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 用户和系统CPU总计所用的秒数 | #### 指标集合：process_open_fds -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------------| -| value | 无 | 打开的文件描述符的数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------| +| value | 无 | 打开的文件描述符的数量 | #### 指标集合：process_max_fds -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------------| -| value | 无 | 打开的文件描述符的最大数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------| +| value | 无 | 打开的文件描述符的最大数量 | #### 指标集合：jvm_info -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-----------| -| runtime | 无 | JVM 版本信息 | -| vendor | 无 | JVM 版本信息 | -| version | 无 | JVM 版本信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| runtime | 无 | JVM 版本信息 | +| vendor | 无 | JVM 版本信息 | +| version | 无 | JVM 版本信息 | #### 指标集合：jvm_memory_bytes_used -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| area | 无 | JVM 内存区域 | -| value | MB | 给定 JVM 内存区域的已用大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| area | 无 | JVM 内存区域 | +| value | MB | 给定 JVM 内存区域的已用大小 | #### 指标集合：jvm_memory_pool_bytes_used -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-----------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已用大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的已用大小 | #### 指标集合：jvm_memory_pool_bytes_committed -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已提交大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的已提交大小 | #### 指标集合：jvm_memory_pool_bytes_max -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------| ----------- | -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的最大大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的最大大小 | #### 指标集合：jvm_threads_state -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-------------| -| state | 无 | 线程状态 | -| value | 无 | 对应线程状态的线程数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------| +| state | 无 | 线程状态 | +| value | 无 | 对应线程状态的线程数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md index 21dcd9a88f3..5755437e80e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md @@ -13,12 +13,11 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit > 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 - **协议使用：SMTP** ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|---------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️无需协议头（例如：https://、http://） | | 监控名称 | 标识此监控的名称。名称需要保持唯一 | @@ -33,9 +32,10 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit #### 指标集：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-------------------| | 响应时间 | 毫秒 | SMTP 服务器响应请求所需的时间 | | 响应状态 | | 响应状态 | | SMTP 服务器标语 | | SMTP 服务器的标语 | | helo 命令返回信息 | | helo 命令返回的响应信息 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md index 086e0a63ac8..a0695849705 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md @@ -19,6 +19,7 @@ keywords: [开源监控工具, 开源 Spring Gateway 监控工具, 监控 Spring spring-boot-starter-actuator ``` + **2. 修改 YML 配置以暴露度量接口:** ```yaml @@ -35,56 +36,55 @@ management: ### 配置参数 -| 参数名称 | 参数描述 | -| ----------- |--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 8080。 | +| 参数名称 | 参数描述 | +|----------|--------------------------------------------------------|-----------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 8080。 | | 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 #### 指标收集: 健康状态 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|--------------------------| -| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|-------------------------| +| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | #### 指标收集: 环境信息 -| 指标名称 | 指标单位 | 指标描述 | -|---------|-------|----------------------------------------------| -| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | -| 端口号 | 无 | 应用程序暴露的端口 | -| 操作系统 | 无 | 运行操作系统 | -| 操作系统架构 | 无 | 运行操作系统的架构 | -| JDK供应商 | 无 | JDK 供应商 | -| JVM版本 | 无 | JVM 版本 | +| 指标名称 | 指标单位 | 指标描述 | +|---------|------|----------------------------------------------| +| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | +| 端口号 | 无 | 应用程序暴露的端口 | +| 操作系统 | 无 | 运行操作系统 | +| 操作系统架构 | 无 | 运行操作系统的架构 | +| JDK供应商 | 无 | JDK 供应商 | +| JVM版本 | 无 | JVM 版本 | #### 指标收集: 线程信息 -| 指标名称 | 指标单位 | 指标描述 | -|-------------|------------|-------------| -| 状态 | 无 | 线程状态 | -| 数量 | 无 | 线程状态对应的线程数量 | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|-------------| +| 状态 | 无 | 线程状态 | +| 数量 | 无 | 线程状态对应的线程数量 | #### 指标收集: 内存使用情况 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|-------------| -| 内存空间 | 无 | 内存空间名称 | -| 内存占用 | MB | 此空间占用的内存大小 | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|------------| +| 内存空间 | 无 | 内存空间名称 | +| 内存占用 | MB | 此空间占用的内存大小 | #### 指标收集: 路由信息 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|----------| -| 路由id | 无 | 路由 ID | -| 匹配规则 | 无 | 路由匹配规则 | -| 资源标识符 | 无 | 服务资源标识符 | -| 优先级 | 无 | 此路由的优先级 | - +| 指标名称 | 指标单位 | 指标描述 | +|-------|------|---------| +| 路由id | 无 | 路由 ID | +| 匹配规则 | 无 | 路由匹配规则 | +| 资源标识符 | 无 | 服务资源标识符 | +| 优先级 | 无 | 此路由的优先级 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md index 280c6cb6b06..e66d4237a13 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md @@ -7,7 +7,6 @@ keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控 > 对SpringBoot2.0 actuator 暴露的通用性能指标进行采集监控。 - ## 监控前操作 如果想要通过此监控类型监控 `SpringBoot` 中的信息，则需要您的SpringBoot应用集成并开启SpringBoot Actuator。 @@ -20,6 +19,7 @@ keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控 spring-boot-starter-actuator ``` + **2、修改YML配置暴露指标接口：** ```yaml @@ -30,7 +30,9 @@ management: include: '*' enabled-by-default: on ``` + *注意：如果你的项目里还引入了认证相关的依赖，比如springboot-security,那么SpringBoot Actuator暴露出的接口可能会被拦截，此时需要你手动放开这些接口，以springboot-security为例，需要在SecurityConfig配置类中加入以下代码：* + ```java public class SecurityConfig extends WebSecurityConfigurerAdapter{ @Override @@ -46,48 +48,50 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ } } ``` + ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口，默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | | Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- |--------------------------------| -| status | 无 | 服务健康状态: UP,Down | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-----------------| +| status | 无 | 服务健康状态: UP,Down | #### 指标集合：environment -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------| -------- |----------------------------| -| profile | 无 | 应用运行profile: prod,dev,test | -| port | 无 | 应用暴露端口 | -| os | 无 | 运行所在操作系统 | -| os_arch | 无 | 运行所在操作系统架构 | -| jdk_vendor | 无 | jdk vendor | -| jvm_version | 无 | jvm version | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|----------------------------| +| profile | 无 | 应用运行profile: prod,dev,test | +| port | 无 | 应用暴露端口 | +| os | 无 | 运行所在操作系统 | +| os_arch | 无 | 运行所在操作系统架构 | +| jdk_vendor | 无 | jdk vendor | +| jvm_version | 无 | jvm version | #### 指标集合：threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------- |------|--------------------| -| state | 无 | 线程状态 | -| number | 无 | 此线程状态对应的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------------| +| state | 无 | 线程状态 | +| number | 无 | 此线程状态对应的线程数量 | #### 指标集合：memory_used -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|------------| -| space | 无 | 内存空间名称 | -| mem_used | MB | 此空间占用内存大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-----------| +| space | 无 | 内存空间名称 | +| mem_used | MB | 此空间占用内存大小 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md index 384f9249d16..56a63068b17 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md @@ -51,7 +51,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -65,23 +65,28 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### 采集指标 #### 指标集合：可用性 -| 指标名称 | 指标单位 | 指标帮助描述 | + +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms | 响应时间 | #### 指标集合：线程 -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------| -| state | 无 | 线程状态 | -| size | 无 | 此线程状态对应的线程数量 | + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------| +| state | 无 | 线程状态 | +| size | 无 | 此线程状态对应的线程数量 | #### 指标集合：内存使用 -| 指标名称 | 指标单位 | 指标帮助描述 | + +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|-----------| | space | 无 | 内存空间名称 | | mem_used | MB | 此空间占用内存大小 | #### 指标集合：健康状态 -| 指标名称 | 指标单位 | 指标帮助描述 | + +| 指标名称 | 指标单位 | 指标帮助描述 | |--------|------|-----------------| -| status | 无 | 服务健康状态: UP,Down | \ No newline at end of file +| status | 无 | 服务健康状态: UP,Down | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md index 5dc66e27cfc..22a5a50ddd8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md @@ -9,68 +9,68 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1433。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 数据库启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------------------------------------------------| +| 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, 缓存池中每秒写的页数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------|------|-------------------------------------------------------------------------------------| +| 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 | 无 | 已连接的会话数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------| +| user_connection | 无 | 已连接的会话数 | -### 常见问题 +### 常见问题 -1. SSL连接问题修复 +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端返回的任何根证书。 +添加`SqlServer`监控时使用高级设置，自定义JDBC URL，拼接的jdbc url后面加上参数配置，```;encrypt=true;trustServerCertificate=true;```这个参数true表示无条件信任server端返回的任何根证书。 -样例：```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` +样例：```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) +参考文档：[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/current/help/ssl_cert.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md index ce0084f7e95..73957e31fb8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md @@ -5,29 +5,30 @@ sidebar_label: SSL证书监控 keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] --- -> 对网站的SSL证书过期时间，响应时间等指标进行监测 +> 对网站的SSL证书过期时间，响应时间等指标进行监测 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，https一般默认为443。 | +| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：certificate +#### 指标集合：certificate + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|----------| +| subject | 无 | 证书名称 | +| expired | 无 | 是否过期 | +| start_time | 无 | 有效期开始时间 | +| start_timestamp | ms毫秒 | 有效期开始时间戳 | +| end_time | 无 | 过期时间 | +| end_timestamp | ms毫秒 | 过期时间戳 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------| -| subject | 无 | 证书名称 | -| expired | 无 | 是否过期 | -| start_time | 无 | 有效期开始时间 | -| start_timestamp | ms毫秒 | 有效期开始时间戳 | -| end_time | 无 | 过期时间 | -| end_timestamp | ms毫秒 | 过期时间戳 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md index ebae858ee4c..2dc77cd8f6f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md @@ -13,14 +13,14 @@ keywords: [开源监控系统, 开源网站监控, 状态页面] 需要填写的字段如下： -| 字段名称 | 字段说明 | 举例 | -|------|-----------------------------------------|---------------------------------------------------------------------------------------------------| -| 组织名称 | 组织的名称 | HertzBeat | -| 组织介绍 | 组织的详细介绍 | Apache HertzBeat (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 | -| 网站链接 | 组织网站的 URL，便于访问者获取更多信息 | https://hertzbeat.apache.org/ | +| 字段名称 | 字段说明 | 举例 | +|------|----------------------------------------|---------------------------------------------------------------------------------------------------| +| 组织名称 | 组织的名称 | HertzBeat | +| 组织介绍 | 组织的详细介绍 | Apache HertzBeat (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 | +| 网站链接 | 组织网站的 URL，便于访问者获取更多信息 | https://hertzbeat.apache.org/ | | 标志图片 | 组织官方标志或 Logo 的图片文件路径或 URL，建议使用 .svg 格式 | https://hertzbeat.apache.org/zh-cn/img/hertzbeat-logo.svg | -| 反馈地址 | 接收问题反馈的地址 | https://github.com/apache/hertzbeat/issues | -| 主题颜色 | 状态页面的主色调。 | 在页面中点击选择 | +| 反馈地址 | 接收问题反馈的地址 | https://github.com/apache/hertzbeat/issues | +| 主题颜色 | 状态页面的主色调。 | 在页面中点击选择 | 填写完组织信息后，点击 `确定`。 @@ -32,12 +32,12 @@ keywords: [开源监控系统, 开源网站监控, 状态页面] 点击 `新增组件` 添加需要监控的组件，并填写以下字段： -| 字段名称 | 字段说明 | 举例 | -|------|-----------------------------------------------------------------------------------------|------------------------------------| -| 服务组件 | 组件服务名称 | 开发环境 ElasticSearch | -| 组件描述 | 组件服务的详细描述信息 | 开发环境，ElasticSearch (ip:192.168.1.1) | -| 服务状态统计方式 | 计算组件服务状态的方式。
自动计算：根据组件监控的状态自动计算显示状态。
手动设置：手动配置组件状态。 | 自动计算 / 手动设置 二选一 | -| 匹配标签 | 状态计算关联标签，使用标签关联的所有监控可用性状态数据来计算组件服务状态。 | 在页面选择组件的标签 | +| 字段名称 | 字段说明 | 举例 | +|----------|-------------------------------------------------------------|-------------------------------------| +| 服务组件 | 组件服务名称 | 开发环境 ElasticSearch | +| 组件描述 | 组件服务的详细描述信息 | 开发环境，ElasticSearch (ip:192.168.1.1) | +| 服务状态统计方式 | 计算组件服务状态的方式。
自动计算：根据组件监控的状态自动计算显示状态。
手动设置：手动配置组件状态。 | 自动计算 / 手动设置 二选一 | +| 匹配标签 | 状态计算关联标签，使用标签关联的所有监控可用性状态数据来计算组件服务状态。 | 在页面选择组件的标签 | ### 设置状态统计时间 @@ -61,13 +61,13 @@ status: ![](/img/docs/help/status-1.png) -| 字段名称 | 字段说明 | 举例 | -|----------|-----------------------------------------------|------------------------------------------------| -| 事件名称 | 事件的标题，应简洁明了地反映事件的核心内容。 | "服务器宕机事件 - 2023 年 4 月 5 日" | -| 影响组件 | 选择受此事件影响的组件。 | 在页面中选择 | -| 过程状态 | 设置事件当前状态，便于追踪处理进度。可选值：调查中 / 已确认 / 观察中 / 已修复 | 已确认 | -| 发布消息 | 向相关方传达的正式通知，包括事件详情、影响评估和应对措施。 | Dear All，开发环境异常，开发人员正在紧急处理，预计两小时内修复。请耐心等待，如有紧急事项请联系 Tom：130xxxx0000！ | +| 字段名称 | 字段说明 | 举例 | +|------|---------------------------------------------|----------------------------------------------------------------------| +| 事件名称 | 事件的标题，应简洁明了地反映事件的核心内容。 | "服务器宕机事件 - 2023 年 4 月 5 日" | +| 影响组件 | 选择受此事件影响的组件。 | 在页面中选择 | +| 过程状态 | 设置事件当前状态，便于追踪处理进度。可选值：调查中 / 已确认 / 观察中 / 已修复 | 已确认 | +| 发布消息 | 向相关方传达的正式通知，包括事件详情、影响评估和应对措施。 | Dear All，开发环境异常，开发人员正在紧急处理，预计两小时内修复。请耐心等待，如有紧急事项请联系 Tom：130xxxx0000！ | > 提示：可以多次发布消息，及时向团队汇报当前状态。 -![](/img/docs/help/status-2.png) \ No newline at end of file +![](/img/docs/help/status-2.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md index cf0cfb417d1..fe5eef718ef 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md @@ -1,49 +1,47 @@ ---- -id: tidb -title: 监控：TiDB数据库监控 -sidebar_label: TiDB数据库 -keywords: [开源监控系统, 开源数据库监控, TiDB数据库监控] ---- - -> 使用 HTTP 和 JDBC 协议对 TiDB 的通用性能指标进行采集监控。 - -### 配置参数 - -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Service端口 | TiDB数据库对外提供用于状态报告的端口，默认为10080。 | -| PD端口 | TiDB数据库的PD端口，默认为2379。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| JDBC端口 | TiDB数据库对外提供用于客户端请求的端口，默认为4000。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| JDBC URL | 数据库使用[JDBC驱动的](https://docs.pingcap.com/zh/tidb/stable/dev-guide-connect-to-tidb#jdbc)连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | - -### 采集指标 - -监控模板将从TiDB系统变量表中检索监控指标，用户可以自行检索[TiDB系统变量表](https://docs.pingcap.com/zh/tidb/stable/system-variables)以查询所需信息或其他系统变量。 - -除此之外，TiDB也提供默认监控指标表，见[Metrics Schema](https://docs.pingcap.com/zh/tidb/stable/metrics-schema)与[METRICS_SUMMARY](https://docs.pingcap.com/zh/tidb/stable/information-schema-metrics-summary)，用户可以根据需求自行添加检索式。 - -由于可以被监控的指标过多，下文仅介绍监控模板中所查询的指标。 - -#### 指标集合：系统变量 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | MySQL 的版本和 TiDB 的版本，例如 '8.0.11-TiDB-v7.5.1' | -| version_comment | 无 | TiDB 版本号的其他信息，例如 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible' | -| version_compile_machine | 无 | 运行 TiDB 的 CPU 架构的名称 | -| version_compile_os | 无 | TiDB 所在操作系统的名称 | -| max_connections | 无 | 该变量表示 TiDB 中同时允许的最大客户端连接数，用于资源控制。默认情况下，该变量值为 0 表示不限制客户端连接数。当本变量的值大于 0 且客户端连接数到达此值时，TiDB 服务端将会拒绝新的客户端连接。 | -| datadir | 无 | 数据存储的位置，位置可以是本地路径 /tmp/tidb。如果数据存储在 TiKV 上，则可以是指向 PD 服务器的路径。变量值的格式为 ${pd-ip}:${pd-port}，表示 TiDB 在启动时连接到的 PD 服务器。 | -| port | 无 | 使用 MySQL 协议时 tidb-server 监听的端口。 | - - - +--- +id: tidb +title: 监控：TiDB数据库监控 +sidebar_label: TiDB数据库 +keywords: [开源监控系统, 开源数据库监控, TiDB数据库监控] +--- + +> 使用 HTTP 和 JDBC 协议对 TiDB 的通用性能指标进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------------------------------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Service端口 | TiDB数据库对外提供用于状态报告的端口，默认为10080。 | +| PD端口 | TiDB数据库的PD端口，默认为2379。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| JDBC端口 | TiDB数据库对外提供用于客户端请求的端口，默认为4000。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| JDBC URL | 数据库使用[JDBC驱动的](https://docs.pingcap.com/zh/tidb/stable/dev-guide-connect-to-tidb#jdbc)连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | + +### 采集指标 + +监控模板将从TiDB系统变量表中检索监控指标，用户可以自行检索[TiDB系统变量表](https://docs.pingcap.com/zh/tidb/stable/system-variables)以查询所需信息或其他系统变量。 + +除此之外，TiDB也提供默认监控指标表，见[Metrics Schema](https://docs.pingcap.com/zh/tidb/stable/metrics-schema)与[METRICS_SUMMARY](https://docs.pingcap.com/zh/tidb/stable/information-schema-metrics-summary)，用户可以根据需求自行添加检索式。 + +由于可以被监控的指标过多，下文仅介绍监控模板中所查询的指标。 + +#### 指标集合：系统变量 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|------------------------------------------------------------------------------------------------------------------| +| version | 无 | MySQL 的版本和 TiDB 的版本，例如 '8.0.11-TiDB-v7.5.1' | +| version_comment | 无 | TiDB 版本号的其他信息，例如 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible' | +| version_compile_machine | 无 | 运行 TiDB 的 CPU 架构的名称 | +| version_compile_os | 无 | TiDB 所在操作系统的名称 | +| max_connections | 无 | 该变量表示 TiDB 中同时允许的最大客户端连接数，用于资源控制。默认情况下，该变量值为 0 表示不限制客户端连接数。当本变量的值大于 0 且客户端连接数到达此值时，TiDB 服务端将会拒绝新的客户端连接。 | +| datadir | 无 | 数据存储的位置，位置可以是本地路径 /tmp/tidb。如果数据存储在 TiKV 上，则可以是指向 PD 服务器的路径。变量值的格式为 ${pd-ip}:${pd-port}，表示 TiDB 在启动时连接到的 PD 服务器。 | +| port | 无 | 使用 MySQL 协议时 tidb-server 监听的端口。 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md index f03ebfab25e..8b5e6c8aca9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md @@ -23,7 +23,7 @@ ${FORMATTER [{ + | - } ]} > 示例输出以当前时间为 `2022-04-24 02:40:00.123` -| 名称 | 描述 | 示例 | +| 名称 | 描述 | 示例 | |--------------|----------------------------|---------------------| | @now | 格式化为 `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | | @date | 格式化为 `yyyy-MM-dd` | 2022-04-24 | @@ -42,9 +42,9 @@ ${FORMATTER [{ + | - } ]} | 名称 | 描述 | |----|----| -| y | 年 | +| y | 年 | | M | 月 | -| d | 日 | +| d | 日 | | H | 小时 | | m | 分钟 | | s | 秒 | @@ -57,10 +57,9 @@ ${FORMATTER [{ + | - } ]} #### 使用示例 1. 简单表达式 - - `${now}` 获取当前时间，并格式化为 `yyyy-MM-dd HH:mm:ss` - - `${time+1h}` 计算当前时间一小时之后的时间，并格式化为 `HH:mm:ss` - - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间，并格式化为 `HH:mm:ss` + - `${now}` 获取当前时间，并格式化为 `yyyy-MM-dd HH:mm:ss` + - `${time+1h}` 计算当前时间一小时之后的时间，并格式化为 `HH:mm:ss` + - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间，并格式化为 `HH:mm:ss` 2. 复杂表达式模板（如果内置的格式化器无法满足需要，可以组合使用多个表达式） - - `${@year}年${@month}月${@day}日`，获取当前日期并按照 yyyy年MM月dd日格式返回 - + - `${@year}年${@month}月${@day}日`，获取当前日期并按照 yyyy年MM月dd日格式返回 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md index c306bebc550..b366ee3c2ac 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md @@ -11,67 +11,65 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | ### Tomcat开启JMX协议步骤 -1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 +1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 -2. vim catalina.sh +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" ``` -参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 +参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md index e5d1be3a140..3ec51e5464a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md index 06c11717b25..ee2f388873b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md @@ -10,7 +10,7 @@ keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |:-------|--------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头 (例如: https://, http://) 。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -26,6 +26,7 @@ keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] #### 指标集合：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|---------|--------| | 响应时间 | 毫秒 (ms) | 网站响应时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md index 5dbb2f2c7c6..8efe5262612 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md @@ -5,26 +5,26 @@ sidebar_label: 网站监测 keywords: [开源监控系统, 开源网站监控] --- -> 对网站是否可用，响应时间等指标进行监测 +> 对网站是否可用，响应时间等指标进行监测 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|-------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | +| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：summary +#### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md index ad8baa7d71b..3bd02f3ce18 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, Websocket监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------------------|--------------------------------------------------------------| | WebSocket服务的Host | 被监控的Websocket的IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -23,7 +23,7 @@ keywords: [ 开源监控系统, Websocket监控 ] #### 指标集合：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|---------| | responseTime | ms | 响应时间 | | httpVersion | 无 | HTTP 版本 | @@ -31,3 +31,4 @@ keywords: [ 开源监控系统, Websocket监控 ] | statusMessage | 无 | 状态消息 | | connection | 无 | 表示连接方式 | | upgrade | 无 | 升级后的协议 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md index 6a1c79b9ede..41447469e61 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md @@ -6,38 +6,39 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 --- > 通过SNMP协议对Windows操作系统的通用性能指标进行采集监控。 -> 注意⚠️ Windows服务器需开启SNMP服务 +> 注意⚠️ 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) +[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 | +| 参数名称 | 参数帮助描述 | +|----------|----------------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Windows SNMP服务对外提供的端口，默认为 161。 | +| SNMP 版本 | SNMP协议版本 V1 V2c V3 | | SNMP 团体字 | SNMP 协议团体名(Community Name)，用于实现SNMP网络管理员访问SNMP管理代理时的身份验证。类似于密码，默认值为 public | -| 超时时间 | 协议连接超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 超时时间 | 协议连接超时时间 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：system -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| name | 无 | 主机名称 | -| descr | 无 | 操作系统描述 | -| uptime | 无 | 系统运行时间 | -| numUsers | 个数 | 当前用户数 | -| services | 个数 | 当前服务数量 | -| processes | 个数 | 当前进程数量 | -| responseTime | ms | 采集响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| name | 无 | 主机名称 | +| descr | 无 | 操作系统描述 | +| uptime | 无 | 系统运行时间 | +| numUsers | 个数 | 当前用户数 | +| services | 个数 | 当前服务数量 | +| processes | 个数 | 当前进程数量 | +| responseTime | ms | 采集响应时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md index 2c88fe1e5a9..c35a0226876 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md @@ -15,69 +15,70 @@ keywords: [大数据监控系统, Apache Yarn监控, 资源管理器监控] ## 配置参数 -| 参数名称 | 参数帮助描述 | -| ---------------- |---------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | -| 端口 | Apache Yarn 的监控端口号，默认为8088。 | -| 查询超时时间 | 查询 Apache Yarn 的超时时间，单位毫秒，默认6000毫秒。 | -| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | +| 参数名称 | 参数帮助描述 | +|--------|-------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | +| 端口 | Apache Yarn 的监控端口号，默认为8088。 | +| 查询超时时间 | 查询 Apache Yarn 的超时时间，单位毫秒，默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | ### 采集指标 #### 指标集合：ClusterMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | ---------------------------------- | -| NumActiveNMs | | 当前存活的 NodeManager 个数 | -| NumDecommissionedNMs | | 当前 Decommissioned 的 NodeManager 个数 | -| NumDecommissioningNMs| | 集群正在下线的节点数 | -| NumLostNMs | | 集群丢失的节点数 | -| NumUnhealthyNMs | | 集群不健康的节点数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|------------------------------------| +| NumActiveNMs | | 当前存活的 NodeManager 个数 | +| NumDecommissionedNMs | | 当前 Decommissioned 的 NodeManager 个数 | +| NumDecommissioningNMs | | 集群正在下线的节点数 | +| NumLostNMs | | 集群丢失的节点数 | +| NumUnhealthyNMs | | 集群不健康的节点数 | #### 指标集合：JvmMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | ------------------------------------ | -| MemNonHeapCommittedM | MB | JVM当前非堆内存大小已提交大小 | -| MemNonHeapMaxM | MB | JVM非堆最大可用内存 | -| MemNonHeapUsedM | MB | JVM当前已使用的非堆内存大小 | -| MemHeapCommittedM | MB | JVM当前已使用堆内存大小 | -| MemHeapMaxM | MB | JVM堆内存最大可用内存 | -| MemHeapUsedM | MB | JVM当前已使用堆内存大小 | -| GcTimeMillis | | JVM GC时间 | -| GcCount | | JVM GC次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|------------------| +| MemNonHeapCommittedM | MB | JVM当前非堆内存大小已提交大小 | +| MemNonHeapMaxM | MB | JVM非堆最大可用内存 | +| MemNonHeapUsedM | MB | JVM当前已使用的非堆内存大小 | +| MemHeapCommittedM | MB | JVM当前已使用堆内存大小 | +| MemHeapMaxM | MB | JVM堆内存最大可用内存 | +| MemHeapUsedM | MB | JVM当前已使用堆内存大小 | +| GcTimeMillis | | JVM GC时间 | +| GcCount | | JVM GC次数 | #### 指标集合：QueueMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------ | -------- | ------------------------------------ | -| queue | | 队列名称 | -| AllocatedVCores | | 分配的虚拟核数(已分配) | -| ReservedVCores | | 预留核数 | -| AvailableVCores | | 可用核数(尚未分配) | -| PendingVCores | | 阻塞调度核数 | -| AllocatedMB | MB | 已分配(已用)的内存大小 | -| AvailableMB | MB | 可用内存(尚未分配) | -| PendingMB | MB | 阻塞调度内存 | -| ReservedMB | MB | 预留内存 | -| AllocatedContainers | | 已分配(已用)的container数 | -| PendingContainers | | 阻塞调度container个数 | -| ReservedContainers | | 预留container数 | -| AggregateContainersAllocated | | 累积的container分配总数 | -| AggregateContainersReleased | | 累积的container释放总数 | -| AppsCompleted | | 完成的任务数 | -| AppsKilled | | 被杀掉的任务数 | -| AppsFailed | | 失败的任务数 | -| AppsPending | | 阻塞的任务数 | -| AppsRunning | | 提正在运行的任务数 | -| AppsSubmitted | | 提交过的任务数 | -| running_0 | | 运行时间小于60分钟的作业个数 | -| running_60 | | 运行时间介于60~300分钟的作业个数 | -| running_300 | | 运行时间介于300~1440分钟的作业个数 | -| running_1440 | | 运行时间大于1440分钟的作业个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|------|-----------------------| +| queue | | 队列名称 | +| AllocatedVCores | | 分配的虚拟核数(已分配) | +| ReservedVCores | | 预留核数 | +| AvailableVCores | | 可用核数(尚未分配) | +| PendingVCores | | 阻塞调度核数 | +| AllocatedMB | MB | 已分配(已用)的内存大小 | +| AvailableMB | MB | 可用内存(尚未分配) | +| PendingMB | MB | 阻塞调度内存 | +| ReservedMB | MB | 预留内存 | +| AllocatedContainers | | 已分配(已用)的container数 | +| PendingContainers | | 阻塞调度container个数 | +| ReservedContainers | | 预留container数 | +| AggregateContainersAllocated | | 累积的container分配总数 | +| AggregateContainersReleased | | 累积的container释放总数 | +| AppsCompleted | | 完成的任务数 | +| AppsKilled | | 被杀掉的任务数 | +| AppsFailed | | 失败的任务数 | +| AppsPending | | 阻塞的任务数 | +| AppsRunning | | 提正在运行的任务数 | +| AppsSubmitted | | 提交过的任务数 | +| running_0 | | 运行时间小于60分钟的作业个数 | +| running_60 | | 运行时间介于60~300分钟的作业个数 | +| running_300 | | 运行时间介于300~1440分钟的作业个数 | +| running_1440 | | 运行时间大于1440分钟的作业个数 | #### 指标集合：runtime -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | ---------------------------- | -| StartTime | | 启动时间戳 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| StartTime | | 启动时间戳 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md index 64d08a259c4..476498549aa 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, Zookeeper监控监控] > 监控 zookeeper 目前的实现方案使用的是 zookeeper 提供的四字命令 + netcat 来收集指标数据 > 需要用户自己将zookeeper的四字命令加入白名单 -1. 加白名单步骤 +1. 加白名单步骤 > 1.找到我们 zookeeper 的配置文件，一般是 `zoo.cfg` > @@ -25,95 +25,96 @@ keywords: [开源监控系统, Zookeeper监控监控] # 将所有命令添加到白名单中 4lw.commands.whitelist=* ``` + > 3.重启服务 -```shell +```shell zkServer.sh restart ``` -2. netcat 协议 +2. netcat 协议 目前实现方案需要我们部署zookeeper的linux服务器，安装netcat的命令环境 > netcat安装步骤 -```shell -yum install -y nc -``` +> +> ```shell +> yum install -y nc +> ``` 如果终端显示以下信息则说明安装成功 + ```shell Complete! ``` - ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Zookeeper的Linux服务器SSH端口。 | -| 查询超时时间 | 设置Zookeeper连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | Zookeeper所在Linux连接用户名 | -| 密码 | Zookeeper所在Linux连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 服务器编号 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|----------------------------------------| +| 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 | 最小延时 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------------|------|------------| +| 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 | 最小延时 | #### 指标集合：envi -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |-----| ----------- | -| zk_version | 无 | ZooKeeper版本 | -| hostname | 无 | 主机名 | -| java_version | 无 | Java版本 | -| java_vendor | 无 | Java供应商 | -| java_home | 无 | Java主目录 | -| java_class_path | 无 | Java类路径 | -| java_library_path | 无 | Java库路径 | -| java_io_tmpdir | 无 | Java临时目录 | -| java_compiler | 无 | Java编译器 | -| os_name | 无 | 操作系统名称 | -| os_arch | 无 | 操作系统架构 | -| os_version | 无 | 操作系统版本 | -| user_name | 无 | 用户名 | -| user_home | 无 | 用户主目录 | -| user_dir | 无 | 用户当前目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-------------| +| zk_version | 无 | ZooKeeper版本 | +| hostname | 无 | 主机名 | +| java_version | 无 | Java版本 | +| java_vendor | 无 | Java供应商 | +| java_home | 无 | Java主目录 | +| java_class_path | 无 | Java类路径 | +| java_library_path | 无 | Java库路径 | +| java_io_tmpdir | 无 | Java临时目录 | +| java_compiler | 无 | Java编译器 | +| os_name | 无 | 操作系统名称 | +| os_arch | 无 | 操作系统架构 | +| os_version | 无 | 操作系统版本 | +| user_name | 无 | 用户名 | +| user_home | 无 | 用户主目录 | +| user_dir | 无 | 用户当前目录 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md index 1e33cec89df..e22cea0502b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md @@ -16,7 +16,6 @@ slug: / [![QQ](https://img.shields.io/badge/QQ-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) [![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) - ## 🎡 介绍 [Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 @@ -31,7 +30,7 @@ slug: / - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ---- @@ -48,7 +47,6 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![hertzbeat](/img/home/9.png) - ### 内置监控类型 **官方内置了大量的监控模版类型，方便用户直接在页面添加使用，一款监控类型对应一个YML监控模版** @@ -113,11 +111,11 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 高性能集群 -> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 +> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 -- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 -- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 +- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 +- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 +- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 ![hertzbeat](/img/docs/cluster-arch.png) @@ -134,10 +132,10 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 易用友好 -- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 -- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 -- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 -- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 +- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 +- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 +- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 +- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 - 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 ### 完全开源 @@ -151,8 +149,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![cncf](/img/home/cncf-landscape-left-logo.svg) ------ - +--- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ----- @@ -269,7 +266,6 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/13.png) - ### 告警静默 - 当通过阈值规则判断触发告警后，会进入到告警静默，告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默，此时间段不发送告警消息。 @@ -301,8 +297,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/9.png) - ------ +--- **还有更多强大的功能快去探索呀。Have Fun!** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/design.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/design.md index 7799d12fe52..7f3854c3e12 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/design.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/design.md @@ -1,9 +1,9 @@ --- id: design title: 设计文档 -sidebar_label: 设计文档 +sidebar_label: 设计文档 --- -### HertzBeat 架构 +### HertzBeat 架构 -![architecture](/img/docs/hertzbeat-arch.svg) +![architecture](/img/docs/hertzbeat-arch.svg) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md index 46699d69a23..0e01e014901 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md @@ -1,20 +1,20 @@ --- id: resource title: 相关资源 -sidebar_label: 相关资源 +sidebar_label: 相关资源 --- -## 图标资源 +## 图标资源 -### HertzBeat LOGO +### HertzBeat LOGO ![logo](/img/hertzbeat-logo.svg) Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) -### HertzBeat Brand LOGO +### HertzBeat Brand LOGO ![logo](/img/hertzbeat-brand.svg) -Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) +Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md index 028138275cb..ce89d825b7e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md @@ -1,7 +1,7 @@ --- id: account-modify title: 配置修改账户密码和加密密钥 -sidebar_label: 更新账户和密钥 +sidebar_label: 更新账户和密钥 --- ## 更新账户 @@ -9,7 +9,7 @@ sidebar_label: 更新账户和密钥 Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射 -配置文件内容参考如下 +配置文件内容参考如下 ```yaml @@ -157,4 +157,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** +**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md index 7dde7ec14e9..01380784169 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md @@ -1,23 +1,25 @@ --- id: custom-config title: 常见参数配置 -sidebar_label: 常见参数配置 +sidebar_label: 常见参数配置 --- 这里描述了如果配置短信服务器，内置可用性告警触发次数等。 -**`hertzbeat`的配置文件`application.yml`** +**`hertzbeat`的配置文件`application.yml`** -### 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 - 安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 +### 配置HertzBeat的配置文件 + +修改位于 `hertzbeat/config/application.yml` 的配置文件 +注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 +安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 1. 配置短信发送服务器 -> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 +> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 + +在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) -在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) ```yaml common: sms: @@ -28,15 +30,17 @@ common: sign-name: 赫兹跳动 template-id: 1343434 ``` + 1.1 腾讯云短信创建签名（sign-name） ![image](https://github.com/apache/hertzbeat/assets/40455946/3a4c287d-b23d-4398-8562-4894296af485) 1.2 腾讯云短信创建正文模板（template-id） + ``` 监控:{1}，告警级别:{2}。内容:{3} ``` -![image](https://github.com/apache/hertzbeat/assets/40455946/face71a6-46d5-452c-bed3-59d2a975afeb) +![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) @@ -44,8 +48,7 @@ common: 1.4 腾讯云访问管理（secret-id、secret-key） ![image](https://github.com/apache/hertzbeat/assets/40455946/36f056f0-94e7-43db-8f07-82893c98024e) - -2. 配置告警自定义参数 +2. 配置告警自定义参数 ```yaml alerter: @@ -53,11 +56,12 @@ alerter: console-url: https://console.tancloud.io ``` -3. 使用外置redis代替内存存储实时指标数据 +3. 使用外置redis代替内存存储实时指标数据 -> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 +> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 + +注意⚠️ `memory.enabled: false, redis.enabled: true` -注意⚠️ `memory.enabled: false, redis.enabled: true` ```yaml warehouse: store: @@ -70,3 +74,4 @@ warehouse: port: 6379 password: 123456 ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md index 8be78289b9a..2bee426c1ab 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md @@ -1,7 +1,7 @@ --- id: docker-compose-deploy title: 通过 Docker Compose 方式安装 HertzBeat -sidebar_label: Docker Compose方式安装 +sidebar_label: Docker Compose方式安装 --- :::tip @@ -13,22 +13,20 @@ sidebar_label: Docker Compose方式安装 执行命令 `docker compose version` 检查是否拥有 Docker Compose 环境。 ::: +1. 下载启动脚本包 - -1. 下载启动脚本包 +从 [下载地址](https://github.com/apache/hertzbeat/releases/download/v1.6.0/apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz) 下载安装脚本包 `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` -从 [下载地址](https://github.com/apache/hertzbeat/releases/download/v1.6.0/apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz) 下载安装脚本包 `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` - -2. 选择使用 HertzBeat + PostgreSQL + VictoriaMetrics 方案 +2. 选择使用 HertzBeat + PostgreSQL + VictoriaMetrics 方案 :::tip - `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` 解压后包含多个部署方案，这里我们推荐选择 `hertzbeat-postgresql-victoria-metrics` 方案。 -- 其它部署方式请详细阅读各个部署方案的 README.md 文件, MySQL 方案需要自行准备 MySQL 驱动包。 +- 其它部署方式请详细阅读各个部署方案的 README.md 文件, MySQL 方案需要自行准备 MySQL 驱动包。 ::: -- 解压脚本包 +- 解压脚本包 -``` +``` $ tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz ``` @@ -51,7 +49,7 @@ docker-compose up -d > 查看各个容器的运行状态，up 为正常运行状态 -``` +``` docker-compose ps ``` @@ -60,9 +58,8 @@ docker-compose ps **HAVE FUN** - ---- - + ### 部署常见问题 **最多的问题就是容器网络问题，请先提前排查** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md index 5804522bd93..d89816f8a12 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md @@ -1,7 +1,7 @@ --- id: docker-deploy title: 通过 Docker 方式安装 HertzBeat -sidebar_label: Docker方式安装 +sidebar_label: Docker方式安装 --- :::tip @@ -10,14 +10,14 @@ sidebar_label: Docker方式安装 ::: :::note -需您的环境中已经拥有 Docker 环境，若未安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/) +需您的环境中已经拥有 Docker 环境，若未安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/) ::: ### 部署 HertzBeat Server 1. 执行以下命令 -```shell +```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -v $(pwd)/data:/opt/hertzbeat/data \ -v $(pwd)/logs:/opt/hertzbeat/logs \ @@ -48,7 +48,7 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ ::: 2. 开始探索 HertzBeat - 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 ### 部署 HertzBeat Collector 集群(可选) @@ -61,7 +61,7 @@ HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数 1. 执行以下命令 -```shell +```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ @@ -69,6 +69,7 @@ $ docker run -d \ -e MANAGER_PORT=1158 \ --name hertzbeat-collector apache/hertzbeat-collector ``` + > 命令参数详解 - `docker run -d` : 通过 Docker 后台运行容器 @@ -90,36 +91,40 @@ $ docker run -d \ 2. 开始探索 HertzBeat Collector 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。 -**HAVE FUN** +**HAVE FUN** ---- -### Docker 方式部署常见问题 +### Docker 方式部署常见问题 **最多的问题就是网络问题，请先提前排查** 1. MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败 -此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + > 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` +> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` 2. 按照流程部署，访问 http://ip:1157/ 无界面 -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 3. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - > 安装初始化此时序数据库 4. 安装配置了时序数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 请检查配置的时许数据库参数是否正确 > 时序数据库对应的 enable 是否设置为true > 注意⚠️若hertzbeat和外置数据库都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 -5. application.yml 是干什么用的 +5. application.yml 是干什么用的 > 此文件是HertzBeat的配置文件，用于配置HertzBeat的各种参数，如数据库连接信息，时序数据库配置等。 @@ -137,4 +142,4 @@ HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml 下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) -具体修改步骤参考 [配置修改账户密码](account-modify) +具体修改步骤参考 [配置修改账户密码](account-modify) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md index 57cf7603a16..6f946707cab 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md @@ -8,21 +8,24 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -[GreptimeDB](https://github.com/GreptimeTeam/greptimedb) is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. +[GreptimeDB](https://github.com/GreptimeTeam/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 -### 通过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 +> 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 127.0.0.1:4000-4003:4000-4003 \ @@ -35,17 +38,17 @@ $ docker run -p 127.0.0.1:4000-4003:4000-4003 \ --postgres-addr 0.0.0.0:4003 ``` - `-v "$(pwd)/greptimedb:/tmp/greptimedb` 为 greptimedb 数据目录本地持久化挂载，需将 `$(pwd)/greptimedb` 替换为实际本地存在的目录，默认使用执行命令的当前目录下的 `greptimedb` 目录作为数据目录。 +`-v "$(pwd)/greptimedb:/tmp/greptimedb` 为 greptimedb 数据目录本地持久化挂载，需将 `$(pwd)/greptimedb` 替换为实际本地存在的目录，默认使用执行命令的当前目录下的 `greptimedb` 目录作为数据目录。 - 使用```$ docker ps```查看数据库是否启动成功 +使用```$ docker ps```查看数据库是否启动成功 -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -67,8 +70,9 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库 GreptimeDB 或者 IoTDB 或者 TDengine 是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md index 91d30eef74d..82b833d459c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md @@ -1,36 +1,39 @@ --- id: influxdb-init title: 依赖时序数据库服务InfluxDB安装初始化(可选) -sidebar_label: 指标数据存储InfluxDB +sidebar_label: 指标数据存储InfluxDB --- Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 +InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** ### 1. 直接使用华为云服务 GaussDB For Influx -> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) - +> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) +> > 获取云数据库对外暴露连接地址，账户密码即可 ⚠️注意云数据库默认开启了SSL，云数据库地址应使用 `https:` -### 2. 通过Docker方式安装InfluxDB +### 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 +> 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 \ @@ -38,17 +41,16 @@ $ docker run -p 8086:8086 \ influxdb:1.8 ``` - `-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 - -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -67,10 +69,9 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 -1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 +1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md index b4c924f6d9f..859e2ba39d0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md @@ -3,6 +3,7 @@ id: iotdb-init title: 依赖时序数据库服务IoTDB安装初始化(可选) sidebar_label: 指标数据存储IoTDB --- + Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 @@ -89,16 +90,15 @@ warehouse: 参数说明： - -| 参数名称 | 参数说明 | -| ------------------- |-------------------------------------------| +| 参数名称 | 参数说明 | +|---------------------|-------------------------------------------| | enabled | 是否启用 | | host | IoTDB数据库地址 | | rpc-port | IoTDB数据库端口 | | node-urls | IoTDB集群地址 | | username | IoTDB数据库账户 | | password | IoTDB数据库密码 | -| version | IoTDB数据库版本，已废弃，仅支持V1.* | +| version | IoTDB数据库版本，已废弃，仅支持V1.* | | query-timeout-in-ms | 查询超时时间 | | expire-time | 数据存储时间，默认'7776000000'（90天,单位为毫秒,-1代表永不过期） | @@ -122,3 +122,4 @@ warehouse: > iot-db enable是否设置为true > 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md index dadca1e3eb1..1b7154a2fcb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md @@ -1,23 +1,27 @@ --- id: mysql-change title: 关系型数据库使用 Mysql 替换依赖的 H2 存储系统元数据(可选) -sidebar_label: 元数据存储Mysql +sidebar_label: 元数据存储Mysql --- -MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 + +MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 -> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 +> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 + +### 通过Docker方式安装MYSQL -### 通过Docker方式安装MYSQL 1. 下载安装Docker环境 Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 - 安装完毕后请于终端检查Docker版本输出是否正常。 + 安装完毕后请于终端检查Docker版本输出是否正常。 + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. Docker安装MYSQl +2. Docker安装MYSQl + ``` $ docker run -d --name mysql \ -p 3306:3306 \ @@ -26,12 +30,14 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) --restart=always \ mysql:5.7 ``` + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 -### 数据库创建 +### 数据库创建 + 1. 进入MYSQL或使用客户端连接MYSQL服务 - `mysql -uroot -p123456` + `mysql -uroot -p123456` 2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 查看hertzbeat数据库是否创建成功 @@ -42,15 +48,16 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) - 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.25.jar. https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip - 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下. -### 修改hertzbeat的配置文件application.yml切换数据源 +### 修改hertzbeat的配置文件application.yml切换数据源 - 配置 HertzBeat 的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 - ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + + 需修改部分原参数: - 需修改部分原参数: ```yaml spring: datasource: @@ -70,7 +77,9 @@ spring: logging: level: SEVERE ``` - 具体替换参数如下,需根据mysql环境配置账户密码IP: + +具体替换参数如下,需根据mysql环境配置账户密码IP: + ```yaml spring: datasource: @@ -90,6 +99,6 @@ spring: level: SEVERE ``` -- 通过docker启动时，建议修改host为宿主机的外网IP地址，包括mysql连接字符串。 +- 通过docker启动时，建议修改host为宿主机的外网IP地址，包括mysql连接字符串。 **启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md index 7a0e627c57c..86c08ce67dd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md @@ -1,7 +1,7 @@ --- id: package-deploy title: 通过安装包安装 HertzBeat -sidebar_label: 安装包方式安装 +sidebar_label: 安装包方式安装 --- :::tip @@ -10,17 +10,19 @@ Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU ::: ### 部署 HertzBeat Server - + 1. 下载安装包 -从 [下载页面](/docs/download) 下载您系统环境对应的安装包版本 `apache-hertzbeat-xxx-incubating-bin.tar.gz` +从 [下载页面](/docs/download) 下载您系统环境对应的安装包版本 `apache-hertzbeat-xxx-incubating-bin.tar.gz` + +2. 设置配置文件(可选) -2. 设置配置文件(可选) +解压安装包到主机 eg: /opt/hertzbeat -解压安装包到主机 eg: /opt/hertzbeat -``` +``` $ tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz ``` + :::tip 位于 `config/application.yml` 的配置文件，您可以根据需求修改配置文件来配置外部依赖的服务，如数据库，时序数据库等参数。 HertzBeat 启动时默认全使用内部服务，但生产环境建议切换为外部数据库服务。 @@ -28,25 +30,26 @@ HertzBeat 启动时默认全使用内部服务，但生产环境建议切换为 建议元数据存储使用 [PostgreSQL](postgresql-change), 指标数据存储使用 [VictoriaMetrics](victoria-metrics-init), 具体步骤参见 -- [内置 H2 数据库切换为 PostgreSQL](postgresql-change) +- [内置 H2 数据库切换为 PostgreSQL](postgresql-change) - [使用 VictoriaMetrics 存储指标数据](victoria-metrics-init) -3. 配置账户文件(可选) +3. 配置账户文件(可选) HertzBeat 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `config/sureness.yml` 的配置文件实现，具体参考 -- [配置修改账户密码](account-modify) +- [配置修改账户密码](account-modify) 4. 启动 -执行位于安装目录 bin 下的启动脚本 startup.sh, windows 环境下为 startup.bat -``` +执行位于安装目录 bin 下的启动脚本 startup.sh, windows 环境下为 startup.bat + +``` $ ./startup.sh ``` 5. 开始探索HertzBeat -浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 ### 部署 HertzBeat Collector 集群(可选) @@ -64,22 +67,23 @@ HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数 2. 设置配置文件 解压安装包到主机 eg: /opt/hertzbeat-collector -``` + +``` $ tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz ``` 配置采集器的配置文件 `config/application.yml` 里面的 HertzBeat Server 连接 IP, 端口, 采集器名称(需保证唯一性)等参数。 ```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} +collector: + dispatch: + entrance: + netty: + enabled: true + identity: ${IDENTITY:} + mode: ${MODE:public} + manager-host: ${MANAGER_HOST:127.0.0.1} + manager-port: ${MANAGER_PORT:1158} ``` > 参数详解 @@ -92,7 +96,8 @@ $ tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz 3. 启动 执行位于安装目录 hertzbeat-collector/bin/ 下的启动脚本 startup.sh, windows 环境下为 startup.bat -``` + +``` $ ./startup.sh ``` @@ -101,9 +106,8 @@ $ ./startup.sh **HAVE FUN** - ---- - + ### 安装包部署常见问题 **最多的问题就是网络环境问题，请先提前排查** @@ -114,16 +118,18 @@ $ ./startup.sh 要求：JAVA17环境 下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) 安装后命令行检查是否成功安装 - ``` - $ java -version - java version "17.0.9" - Java(TM) SE Runtime Environment 17.0.9 (build 17.0.9+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) - ``` +``` +$ java -version +java version "17.0.9" +Java(TM) SE Runtime Environment 17.0.9 (build 17.0.9+8-LTS-237) +Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) + +``` 2. 按照流程部署，访问 http://ip:1157/ 无界面 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md index 196e5ac2abd..331f021c747 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md @@ -3,44 +3,49 @@ id: postgresql-change title: 关系型数据库使用 PostgreSQL 替换依赖的 H2 存储系统元数据(推荐) sidebar_label: 元数据存储PostgreSQL(推荐) --- -PostgreSQL 是一个功能强大，开源的关系型数据库管理系统（RDBMS）。Apache HertzBeat (incubating) 除了支持使用默认内置的 H2 数据库外，还可以切换为使用 PostgreSQL 存储监控信息，告警信息，配置信息等结构化关系数据。 -注意⚠️ 使用外置 PostgreSQL 数据库替换内置 H2 数据库为可选项，但建议生产环境配置，以提供更好的性能 +PostgreSQL 是一个功能强大，开源的关系型数据库管理系统（RDBMS）。Apache HertzBeat (incubating) 除了支持使用默认内置的 H2 数据库外，还可以切换为使用 PostgreSQL 存储监控信息，告警信息，配置信息等结构化关系数据。 -> 如果您已有 PostgreSQL 环境，可直接跳到数据库创建那一步。 +注意⚠️ 使用外置 PostgreSQL 数据库替换内置 H2 数据库为可选项，但建议生产环境配置，以提供更好的性能 +> 如果您已有 PostgreSQL 环境，可直接跳到数据库创建那一步。 -### 通过 Docker 方式安装 PostgreSQL +### 通过 Docker 方式安装 PostgreSQL 1. 下载安装 Docker 环境 - Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。安装完毕后请于终端检查 Docker 版本输出是否正常。 + Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。安装完毕后请于终端检查 Docker 版本输出是否正常。 + ```shell $ docker -v Docker version 20.10.12, build e91ed57 ``` - 2. Docker 安装 PostgreSQL + ```shell $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` + 使用 ```$ docker ps``` 查看数据库是否启动成功 -### 数据库创建 +### 数据库创建 + +1. 进入 PostgreSQL 或使用客户端连接 PostgreSQL 服务 -1. 进入 PostgreSQL 或使用客户端连接 PostgreSQL 服务 ```shell su - postgres psql ``` - -2. 创建名称为 hertzbeat 的数据库 +2. 创建名称为 hertzbeat 的数据库 + ```sql CREATE DATABASE hertzbeat; ``` -3. 查看 hertzbeat 数据库是否创建成功 +3. 查看 hertzbeat 数据库是否创建成功 + ```sql SELECT * FROM pg_database where datname='hertzbeat'; ``` + ### 修改 hertzbeat 的配置文件 application.yml 切换数据源 1. 配置 HertzBeat 的配置文件 @@ -68,7 +73,9 @@ spring: logging: level: SEVERE ``` + 具体替换参数如下,需根据 PostgreSQL 环境配置账户密码 IP: + ```yaml spring: datasource: @@ -88,4 +95,4 @@ spring: level: SEVERE ``` -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md index 3702a89d87d..064230770a6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md @@ -1,18 +1,18 @@ --- id: quickstart title: 快速开始 -sidebar_label: 快速开始 +sidebar_label: 快速开始 --- ### 🐕 开始使用 - 如果您是想将 Apache HertzBeat (incubating) 部署到本地搭建监控系统，请参考下面的部署文档进行操作。 +### 🍞 HertzBeat安装 -### 🍞 HertzBeat安装 > HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持X86/ARM64。 -#### 方式一：Docker方式快速安装 +#### 方式一：Docker方式快速安装 1. `docker` 环境仅需一条命令即可开始 @@ -29,14 +29,15 @@ sidebar_label: 快速开始 ``` 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) +更多配置详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy) -#### 方式二：通过安装包安装 +#### 方式二：通过安装包安装 1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [Download Page](https://hertzbeat.apache.org/docs/download) 2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) @@ -45,6 +46,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 5. 部署采集器集群(可选) - 下载您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [Download Page](https://hertzbeat.apache.org/docs/download) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` + ```yaml collector: dispatch: @@ -59,9 +61,9 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 -更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) +更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) -#### 方式三：本地代码启动 +#### 方式三：本地代码启动 1. 此为前后端分离项目，本地代码调试需要分别启动后端工程`manager`和前端工程`web-app` 2. 后端：需要`maven3+`, `java17`和`lombok`环境，修改`YML`配置信息并启动`manager`服务 @@ -74,7 +76,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 通过 [docker-compose部署脚本](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) 一次性把 postgresql/mysql 数据库, victoria-metrics/iotdb/tdengine 时序数据库和 hertzbeat 安装部署。 -详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) +详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) ##### 方式五：Kubernetes Helm Charts 部署 hertzbeat+collector+postgresql+tsdb diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/rainbond-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/rainbond-deploy.md index 5da0679d327..8e01b8cf7a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/rainbond-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/rainbond-deploy.md @@ -1,7 +1,7 @@ --- id: rainbond-deploy title: 使用 Rainbond 部署 HertzBeat -sidebar_label: Rainbond方式部署 +sidebar_label: Rainbond方式部署 --- 如果你不熟悉 Kubernetes，想在 Kubernetes 中安装 Apache HertzBeat (incubating)，可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台，可以很简单的将你的应用部署到 Kubernetes中。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md index f3892a20a64..1eb90ccaa83 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md @@ -4,7 +4,6 @@ title: SSL证书过期监控使用案例 sidebar_label: SSL证书过期监控使用案例 --- - 现在大部分网站都默认支持 HTTPS，我们申请的证书一般是3个月或者1年，很容易随着时间的流逝SSL证书过期了我们却没有第一时间发现，或者在过期之前没有及时更新证书。 这篇文章介绍如果使用 hertzbeat 监控系统来检测我们网站的SSL证书有效期，当证书过期时或证书快过期前几天，给我们发告警消息。 @@ -13,7 +12,6 @@ sidebar_label: SSL证书过期监控使用案例 Apache HertzBeat (incubating) 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 - github: https://github.com/apache/hertzbeat #### 安装 HertzBeat @@ -30,10 +28,8 @@ github: https://github.com/apache/hertzbeat > 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书 - ![](/img/docs/start/ssl_1.png) - 2. 配置监控网站 > 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md index b64743d1f7b..9837a5a5b99 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md @@ -8,24 +8,26 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 +TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 +### 通过Docker方式安装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 +> 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 \ @@ -34,23 +36,23 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ tdengine/tdengine:3.0.4.0 ``` - `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 - `-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 +`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 +使用```$ docker ps```查看数据库是否启动成功 + +### 创建数据库实例 -### 创建数据库实例 +> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) -> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) +1. 进入数据库Docker容器 -1. 进入数据库Docker容器 ``` $ docker exec -it tdengine /bin/bash ``` - 2. 修改账户密码 > 建议您修改密码。TDengine默认的账户密码是 root/taosdata - > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: + > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: ``` root@tdengine-server:~/TDengine-server# taos @@ -58,6 +60,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. taos> ``` + > 在 TDengine CLI 中使用 alter user 命令可以修改用户密码，缺省密码为 taosdata 3. 创建名称为hertzbeat的数据库 @@ -77,24 +80,23 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ taos> show databases; taos> use hertzbeat; ``` - 5. 退出TDengine CLI ``` 输入 q 或 quit 或 exit 回车 ``` -**注意⚠️若是安装包安装的TDengine** +**注意⚠️若是安装包安装的TDengine** > 除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -112,19 +114,24 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 -2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] +2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 -3. 监控详情历史图片不展示或无数据，已经配置了TDengine +3. 监控详情历史图片不展示或无数据，已经配置了TDengine + > 请确认是否安装的TDengine版本为3.0以上，版本2.x不支持兼容 4. 安装配置了TDengine数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 请检查配置参数是否正确 > td-engine enable是否设置为true > 注意⚠️若hertzbeat和TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP -> 可根据logs目录下启动日志排查 +> 可根据logs目录下启动日志排查 + 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 6a076a89d69..8c8becc369d 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 @@ -7,6 +7,7 @@ sidebar_label: 1.6.0升级指南 # HertzBeat 1.6.0 升级指南 ### 注意：该指南适用于1.5.0向1.6.0版本升级 + ### 如果你使用更老的版本，建议使用导出功能重新安装，或先升级到1.5.0再按本指南升级到1.6.0 ### 二进制安装包升级 @@ -18,6 +19,7 @@ sidebar_label: 1.6.0升级指南 - 当你的服务器中默认环境变量为Java17时，这一步你无需任何操作。 - 当你的服务器中默认环境变量不为Java17时，如Java8、Java11，若你服务器中**没有**其他应用需要低版本Java，根据你的系统，到 [https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) 选择相应的发行版下载，并在搜索引擎搜索如何设置新的环境变量指向新的Java17。 - 当你的服务器中默认环境变量不为Java17时，如Java8、Java11，若你服务器中**有**其他应用需要低版本Java，根据你的系统，到 [https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) 选择相应的发行版下载，并将解压后的文件夹重命名为java，复制到Hertzbeat的解压目录下。 + 2. 升级数据库 打开[https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration)， @@ -30,6 +32,7 @@ sidebar_label: 1.6.0升级指南 - `application.yml`一般需要修改以下部分 默认为： + ```yaml datasource: driver-class-name: org.h2.Driver @@ -48,7 +51,9 @@ sidebar_label: 1.6.0升级指南 logging: level: SEVERE ``` + 如若修改为mysql数据库，给出一个示例： + ```yaml datasource: driver-class-name: com.mysql.cj.jdbc.Driver @@ -69,6 +74,7 @@ sidebar_label: 1.6.0升级指南 ``` - `sureness.yml`修改是可选的，一般在你需要修改账号密码时 + ```yaml # account info config # eg: admin has role [admin,user], password is hertzbeat @@ -93,10 +99,10 @@ account: role: [user] ``` - 4. 添加相应的数据库驱动 - 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动，复制到安装目录下`ext-lib`中。 + 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动，复制到安装目录下`ext-lib`中。 + mysql：[https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.18.zip) oracle（如果你要监控oracle，这两个驱动是必须的） [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) @@ -106,6 +112,7 @@ oracle（如果你要监控oracle，这两个驱动是必须的） ### Docker 方式升级 - Mysql数据库 1. 关闭 HertzBeat 容器 + ``` docker stop hertzbeat ``` @@ -122,6 +129,7 @@ docker stop hertzbeat - `application.yml`一般需要修改以下部分 默认为： + ```yaml datasource: driver-class-name: com.mysql.cj.jdbc.Driver @@ -142,6 +150,7 @@ docker stop hertzbeat ``` - `sureness.yml`修改是可选的，一般在你需要修改账号密码时 + ```yaml # account info config # eg: admin has role [admin,user], password is hertzbeat @@ -168,7 +177,8 @@ account: 4. 添加相应的数据库驱动 - 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + mysql：[https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.18.zip) oracle（如果你要监控oracle，这两个驱动是必须的） [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) @@ -178,6 +188,7 @@ oracle（如果你要监控oracle，这两个驱动是必须的） ### Docker安装升级 - H2内置数据库(生产环境不推荐使用H2) 1. 关闭 HertzBeat 容器 + ``` docker stop hertzbeat ``` @@ -187,9 +198,11 @@ docker stop hertzbeat 前题你已经将 H2 数据库文件 data 目录挂载到本地，或者启动老容器手动将 /opt/hertzbeat/data 目录拷贝出来。 下载 h2 驱动 jar [https://mvnrepository.com/artifact/com.h2database/h2/2.2.220](https://mvnrepository.com/artifact/com.h2database/h2/2.2.220) 使用 h2 驱动 jar 本地启动数据库 + ``` java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 ``` + 打开[https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration)， 选择你使用的数据库的目录下相应的 `V160__update_column.sql`文件在 H2 执行升级sql。 @@ -200,6 +213,7 @@ java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 - `application.yml`一般需要修改以下部分 默认为： + ```yaml datasource: driver-class-name: org.h2.Driver @@ -220,6 +234,7 @@ java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 ``` - `sureness.yml`修改是可选的，一般在你需要修改账号密码时 + ```yaml # account info config # eg: admin has role [admin,user], password is hertzbeat @@ -244,10 +259,10 @@ account: role: [user] ``` - 4. 添加相应的数据库驱动 - 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + 由于apache基金会对于license合规的要求，HertzBeat的安装包不能包含mysql，oracle等gpl许可的依赖，需要用户自行添加，用户可通过以下链接自行下载驱动 jar 放到本地 `ext-lib`目录下，然后启动时将`ext-lib`挂载到容器的 `/opt/hertzbeat/ext-lib`目录。 + mysql：[https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.18.zip) oracle（如果你要监控oracle，这两个驱动是必须的） [https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar) @@ -255,8 +270,8 @@ oracle（如果你要监控oracle，这两个驱动是必须的） 接下来，像之前那样 Docker 运行启动，即可体验最新的HertzBeat1.6.0！ ### 通过导出导入升级 -> 若不想如上繁琐的脚本升级方式，可以直接将老环境的监控任务和阈值信息导出导入 +> 若不想如上繁琐的脚本升级方式，可以直接将老环境的监控任务和阈值信息导出导入 1. 部署一套最新版本的新环境 2. 在页面上将老环境的监控任务和阈值信息导出。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md index 461065fa003..2e2124534ec 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md @@ -1,7 +1,7 @@ --- id: upgrade title: HertzBeat 新版本更新指引 -sidebar_label: 版本更新指引 +sidebar_label: 版本更新指引 --- **Apache HertzBeat (incubating) 的发布版本列表** @@ -14,8 +14,6 @@ HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据 **升级前您需要保存备份好数据库的数据文件和监控模版文件** - - ### Docker部署方式的升级 1. 若使用了自定义监控模版 @@ -23,32 +21,26 @@ HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据 - `docker cp hertzbeat:/opt/hertzbeat/define ./define` - 然后在后续升级启动 docker 容器的时候需要挂载上这个 define 目录，`-v $(pwd)/define:/opt/hertzbeat/define` - `-v $(pwd)/define:/opt/hertzbeat/define` - -2. 若使用内置默认 H2 数据库 +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/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** +**HAVE FUN** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md index abc8a1f94b2..4beebcd5045 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md @@ -1,7 +1,7 @@ --- id: victoria-metrics-init title: 依赖时序数据库服务VictoriaMetrics安装初始化 -sidebar_label: 指标数据存储VictoriaMetrics(推荐) +sidebar_label: 指标数据存储VictoriaMetrics(推荐) --- Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) @@ -11,21 +11,23 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 +### 通过Docker方式安装VictoriaMetrics -### 通过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 +> 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 \ @@ -34,16 +36,16 @@ $ docker run -d -p 8428:8428 \ victoriametrics/victoria-metrics:v1.95.1 ``` - `-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 - 使用```$ docker ps```查看数据库是否启动成功 +`-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 +使用```$ docker ps```查看数据库是否启动成功 -3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 +3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** ```yaml warehouse: @@ -61,8 +63,9 @@ warehouse: 4. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，但会影响历史图表数据和存储时长等。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md index 55d89c73cba..219620a230c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md @@ -4,27 +4,27 @@ title: 监控模版中心 sidebar_label: 监控模版 --- -> Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 - +> Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ -这是它的架构原理: +这是它的架构原理: ![hertzBeat](/img/docs/hertzbeat-arch.png) -**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版，用户可以导入这些模版到hertzbeat系统中，使其支持对应类型的监控，非常方便！** +**我们将所有监控采集类型(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)
+ 👉 [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)
@@ -32,7 +32,7 @@ sidebar_label: 监控模版  👉 [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)
@@ -49,7 +49,7 @@ sidebar_label: 监控模版  👉 [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)
@@ -64,7 +64,6 @@ sidebar_label: 监控模版  👉 [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)
@@ -78,13 +77,12 @@ sidebar_label: 监控模版  👉 [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)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md index 4df0501dd83..cdd62f2209a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md @@ -3,14 +3,17 @@ id: extend-http-default title: HTTP协议系统默认解析方式 sidebar_label: 系统默认解析方式 --- -> HTTP接口调用获取响应数据后，用HertzBeat默认的解析方式去解析响应数据。 -**此需接口响应数据结构符合HertzBeat指定的数据结构规则** +> HTTP接口调用获取响应数据后，用HertzBeat默认的解析方式去解析响应数据。 -### HertzBeat数据格式规范 -注意⚠️ 响应数据为JSON +**此需接口响应数据结构符合HertzBeat指定的数据结构规则** + +### HertzBeat数据格式规范 + +注意⚠️ 响应数据为JSON 单层格式：key-value + ```json { "metricName1": "metricValue", @@ -19,7 +22,9 @@ sidebar_label: 系统默认解析方式 "metricName4": "metricValue" } ``` + 多层格式：数组里面套key-value + ```json [ { @@ -36,9 +41,11 @@ sidebar_label: 系统默认解析方式 } ] ``` + 样例： 查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 -若只有一台虚拟机，其单层格式为: +若只有一台虚拟机，其单层格式为: + ```json { "hostname": "linux-1", @@ -48,7 +55,9 @@ sidebar_label: 系统默认解析方式 "runningTime": 100 } ``` -若有多台虚拟机，其多层格式为: + +若有多台虚拟机，其多层格式为: + ```json [ { @@ -75,7 +84,7 @@ sidebar_label: 系统默认解析方式 ] ``` -**对应的监控模版YML可以配置为如下** +**对应的监控模版YML可以配置为如下** ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -148,3 +157,4 @@ metrics: # 这里使用HertzBeat默认解析 parseType: default ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md index aac574f42ad..b8699c93dcc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md @@ -1,19 +1,17 @@ --- id: extend-http-example-hertzbeat title: 教程一:适配一款基于HTTP协议的监控类型 -sidebar_label: 教程一:适配一款HTTP协议监控 +sidebar_label: 教程一:适配一款HTTP协议监控 --- -通过此教程我们一步一步描述如何在hertzbeat监控系统下新增适配一款基于http协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +通过此教程我们一步一步描述如何在hertzbeat监控系统下新增适配一款基于http协议的监控类型。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 ### HTTP协议解析通用响应结构体，获取指标数据 > 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - ``` { "code": 200, @@ -22,6 +20,7 @@ sidebar_label: 教程一:适配一款HTTP协议监控 } ``` + 如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API `http://localhost:1157/api/summary`, 其响应数据为: @@ -58,7 +57,6 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - ### 新增自定义监控模版YML **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -188,32 +186,24 @@ metrics: **新增完毕，现在我们重启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!!! - ---- #### 完！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md index 5bbfe58cf32..93379199b19 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md @@ -6,15 +6,15 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 通过此教程我们一步一步描述如何在教程一的基础上改造，新增一个监控指标，先调用认证接口获取TOKEN后，使用TOKEN作为参数供后面的监控指标采集认证使用。 -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 -### 请求流程 +### 请求流程 -【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 +【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 > 这里我们依然用教程一的hertzbeat监控举例！hertzbeat后台接口不仅仅支持教程一使用的basic直接账户密码认证，也支持token认证。 -**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: +**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: ```json { @@ -22,7 +22,8 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 "identifier": "admin" } ``` -**响应结构数据如下**: + +**响应结构数据如下**: ```json { @@ -99,9 +100,9 @@ metrics: ...... ``` -### 定义监控指标`auth`登录请求获取`token` +### 定义监控指标`auth`登录请求获取`token` -1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. +1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. ```yaml @@ -206,16 +207,13 @@ metrics: ![](/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`作为变量参数给后面的监控指标采集使用 +### 将`token`作为变量参数给后面的监控指标采集使用 **在`app-hertzbeat_token.yml`新增一个监控指标定义 `summary` 同教程一中的`summary`相同, 设置采集优先级为1** **设置此监控指标的HTTP协议配置中认证方式为 `Bearer Token` 将上一个监控指标`auth`采集的指标`token`作为参数给其赋值，使用`^o^`作为内部替换符标识，即`^o^token^o^`。如下:** @@ -231,7 +229,7 @@ metrics: bearerTokenToken: ^o^token^o^ ``` -**最终`app-hertzbeat_token.yml`定义如下:** +**最终`app-hertzbeat_token.yml`定义如下:** ```yaml @@ -368,9 +366,9 @@ metrics: ``` -**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** +**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** -![](/img/docs/advanced/extend-http-example-8.png) +![](/img/docs/advanced/extend-http-example-8.png) ![](/img/docs/advanced/extend-http-example-9.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md index fb3a6ef36d9..71a6b3f116e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md @@ -3,16 +3,18 @@ id: extend-http-jsonpath title: HTTP协议JsonPath解析方式 sidebar_label: JsonPath解析方式 --- + > HTTP接口调用获取响应数据后，用JsonPath脚本解析的解析方式去解析响应数据。 注意⚠️ 响应数据为JSON格式 -**使用JsonPath脚本将响应数据解析成符合HertzBeat指定的数据结构规则的数据** +**使用JsonPath脚本将响应数据解析成符合HertzBeat指定的数据结构规则的数据** + +#### JsonPath操作符 -#### JsonPath操作符 -[JSONPath在线验证](https://www.jsonpath.cn) +[JSONPath在线验证](https://www.jsonpath.cn) -| JSONPATH | 帮助描述 | +| JSONPATH | 帮助描述 | |------------------|-----------------------------------| | $ | 根对象或元素 | | @ | 当前对象或元素 | @@ -25,8 +27,10 @@ sidebar_label: JsonPath解析方式 | ?() | 过滤器（脚本）表达式. | | () | 脚本表达式. | -#### HertzBeat数据格式规范 +#### HertzBeat数据格式规范 + 单层格式：key-value + ```json { "metricName1": "metricValue", @@ -35,7 +39,9 @@ sidebar_label: JsonPath解析方式 "metricName4": "metricValue" } ``` + 多层格式：数组里面套key-value + ```json [ { @@ -53,10 +59,11 @@ sidebar_label: JsonPath解析方式 ] ``` -#### 样例 +#### 样例 查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 -接口返回的原始数据如下： +接口返回的原始数据如下： + ```json { "firstName": "John", @@ -80,7 +87,8 @@ sidebar_label: JsonPath解析方式 } ``` -我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： +我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： + ```json [ { @@ -93,9 +101,10 @@ sidebar_label: JsonPath解析方式 } ] ``` -此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 -**对应的监控模版YML可以配置为如下** +此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 + +**对应的监控模版YML可以配置为如下** ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -166,3 +175,4 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md index c4175928195..c12ea3539fe 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md @@ -1,21 +1,22 @@ --- id: extend-http title: HTTP协议自定义监控 -sidebar_label: HTTP协议自定义监控 +sidebar_label: HTTP协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 -### HTTP协议采集流程 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 + +### HTTP协议采集流程 + 【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 -HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 +HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 **系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) -**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) - +**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -23,15 +24,14 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ------- -下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 +下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 -### 监控模版YML +### 监控模版YML > 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 -样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 - +样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -203,3 +203,4 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md index f3453c6de80..9bcd5cded08 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md @@ -1,29 +1,34 @@ --- id: extend-jdbc title: JDBC协议自定义监控 -sidebar_label: JDBC协议自定义监控 +sidebar_label: JDBC协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 -> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 -### JDBC协议采集流程 -【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 +> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 + +### JDBC协议采集流程 + +【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 由流程可见，我们自定义一个JDBC协议的监控类型，需要配置JDBC请求参数，配置获取哪些指标，配置查询SQL语句。 -### 数据解析方式 +### 数据解析方式 + SQL查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有三种：oneRow, multiRow, columns -#### **oneRow** -> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 +#### **oneRow** + +> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book limit 1; -这里指标字段就能和响应数据一一映射为一行采集数据。 +这里指标字段就能和响应数据一一映射为一行采集数据。 #### **multiRow** -> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 + +> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 例如： 查询的指标字段为：one tow three four @@ -31,33 +36,34 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 这里指标字段就能和响应数据一一映射为多行采集数据。 #### **columns** -> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 + +> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 例如： 查询字段：one tow three four 查询SQL：select key, value from book; -SQL响应数据： +SQL响应数据： -| key | value | -|----------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +| key | value | +|-------|-------| +| one | 243 | +| two | 435 | +| three | 332 | +| four | 643 | -这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 +这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) - ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 -### 监控模版YML +下面详细介绍下文件的配置用法，请注意看使用注释。 + +### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 @@ -237,3 +243,4 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md index e1ce0dd90a3..032f09f4f14 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md @@ -1,38 +1,38 @@ --- id: extend-jmx title: JMX协议自定义监控 -sidebar_label: JMX协议自定义监控 +sidebar_label: JMX协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 -> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 +> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 + +### JMX协议采集流程 -### JMX协议采集流程 -【**对端JAVA应用暴露JMX服务**】->【**HertzBeat直连对端JMX服务**】->【**获取配置的 Mbean Object 数据**】->【**指标数据提取**】 +【**对端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协议采集指标数据。 - +样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -236,3 +236,4 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md index c951f1bc190..a59d9b1898a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md @@ -1,12 +1,13 @@ --- id: extend-point title: 自定义监控 -sidebar_label: 自定义监控 +sidebar_label: 自定义监控 --- + > HertzBeat拥有自定义监控能力，您只需配置监控模版YML就能适配一款自定义的监控类型。 -> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 +> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 -### 自定义流程 +### 自定义流程 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -14,13 +15,13 @@ sidebar_label: 自定义监控 ------- -### 监控模版YML +### 监控模版YML **HertzBeat的设计是一个监控模版对应一个监控类型，所有监控类型都是由监控模版来定义的**。 -> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 +> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 -下面使用样例详细介绍下这监控模版YML的配置用法。 +下面使用样例详细介绍下这监控模版YML的配置用法。 样例：自定义一个 `app` 名称为 `example2` 的自定义监控类型，其使用HTTP协议采集指标数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md index 3ff65d60a17..387d67c5987 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md @@ -1,38 +1,38 @@ --- id: extend-snmp title: SNMP协议自定义监控 -sidebar_label: SNMP协议自定义监控 +sidebar_label: SNMP协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 -> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 +> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 + +### SNMP协议采集流程 -### SNMP协议采集流程 -【**对端开启SNMP服务**】->【**HertzBeat直连对端SNMP服务**】->【**根据配置抓取对端OID指标信息**】->【**指标数据提取**】 +【**对端开启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 协议采集指标数据。 - +样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring @@ -207,3 +207,4 @@ metrics: processes: 1.3.6.1.2.1.25.1.6.0 location: 1.3.6.1.2.1.1.6.0 ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md index a38086f8dd9..0c4fa9cb9ab 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md @@ -1,21 +1,25 @@ --- id: extend-ssh title: SSH协议自定义监控 -sidebar_label: SSH协议自定义监控 +sidebar_label: SSH协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 -> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 +> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 + +### SSH协议采集流程 -### SSH协议采集流程 -【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 +【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 由流程可见，我们自定义一个SSH协议的监控类型，需要配置SSH请求参数，配置获取哪些指标，配置查询脚本语句。 -### 数据解析方式 +### 数据解析方式 + SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有两种：oneRow, multiRow，能满足绝大部分指标需求。 -#### **oneRow** -> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 +#### **oneRow** + +> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 例如： 需要查询Linux的指标 hostname-主机名称，uptime-启动时间 @@ -23,31 +27,37 @@ SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获 启动时间原始查询命令：`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` +uptime值为 `14:00:15 up 72 days` -这里指标字段就能和响应数据一一映射为一行采集数据。 +这里指标字段就能和响应数据一一映射为一行采集数据。 #### **multiRow** -> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 + +> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 例如： 查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 -内存指标原始查询命令为：`free -m`, 控制台响应： +内存指标原始查询命令为：`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 @@ -55,22 +65,22 @@ total used free buff_cache available 这里指标字段就能和响应数据一一映射为采集数据。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 + +下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 -样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 - +样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -206,3 +216,4 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md index a639a13a8b9..ff411818bdc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md @@ -4,16 +4,14 @@ title: 自定义适配一款基于HTTP协议的新监控类型 sidebar_label: 教程案例 --- -通过此教程我们一步一步描述如何在hertzbeat监控系统下自定义新增适配一款基于http协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +通过此教程我们一步一步描述如何在hertzbeat监控系统下自定义新增适配一款基于http协议的监控类型。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 ### HTTP协议解析通用响应结构体，获取指标数据 > 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - ``` { "code": 200, @@ -22,6 +20,7 @@ sidebar_label: 教程案例 } ``` + 如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API `http://localhost:1157/api/summary`, 其响应数据为: @@ -58,12 +57,11 @@ sidebar_label: 教程案例 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - ### 新增配置监控模版YML **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 +定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 定义采集类型是啥，需要用哪种协议采集方式，采集的指标是啥，协议的配置参数等。我们直接复用 `api`监控模版 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可，如下：注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 @@ -221,32 +219,24 @@ metrics: **点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`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!!! - ---- #### 完！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md index b2d8f1489f5..29d5478158a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 **使用协议：JMX** -### 监控前操作 +### 监控前操作 > 您需要在 ActiveMQ 开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 ActiveMQ 进行指标采集。 @@ -23,9 +23,10 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 ``` -2. 修改安装目录下的 `bin/env` 文件，配置JMX 端口 IP等 +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" @@ -34,7 +35,9 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" ``` -更新为如下配置，⚠️注意修改`本机对外IP` + +更新为如下配置，⚠️注意修改`本机对外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" @@ -49,25 +52,25 @@ 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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 监控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. | @@ -88,57 +91,56 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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 | - +#### 指标集合：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 | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| 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 index 5323ede8110..52367155d89 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md @@ -9,33 +9,31 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：airflow_health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | -------------------- | -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|------------------| +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | #### 指标集合：airflow_version -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | --------------- | -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------| +| 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 index 68cf7339eae..5198b961b66 100644 --- 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 @@ -6,13 +6,13 @@ sidebar_label: 告警模板登录台地址 > 阈值触发后发送告警信息，通过钉钉/企业微信/飞书机器人通知或者使用邮箱通知的时候，告警内容中有登录控制台的详情链接 - ### 自定义设置 在我们的启动配置文件application.yml中，找到下面的配置 + ```yml alerter: console-url: #这里就是我们的自定义控制台地址 ``` -默认值是赫兹跳动的官方控制台地址 \ No newline at end of file +默认值是赫兹跳动的官方控制台地址 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md index aec6342f7d3..9d0ee3b088f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md @@ -5,15 +5,15 @@ sidebar_label: 告警钉钉机器人通知 keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 +> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 -### 操作步骤 +### 操作步骤 1. **【钉钉桌面客户端】-> 【群设置】-> 【智能群助手】-> 【添加新建机器人-选自定义】-> 【设置机器人名称头像】-> 【注意⚠️设置自定义关键字: HertzBeat】 ->【添加成功后复制其WebHook地址】** -> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 +> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 -![email](/img/docs/help/alert-notice-8.png) +![email](/img/docs/help/alert-notice-8.png) 2. **【保存机器人的WebHook地址access_token值】** @@ -24,18 +24,18 @@ keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警 ![email](/img/docs/help/alert-notice-9.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 钉钉机器人通知常见问题 -### 钉钉机器人通知常见问题 +1. 钉钉群未收到机器人告警通知 -1. 钉钉群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查钉钉机器人是否配置了安全自定义关键字：HertzBeat > 请排查是否配置正确机器人ACCESS_TOKEN，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群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 index d6c4879a2ba..9694126d0dd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md @@ -5,68 +5,66 @@ sidebar_label: 告警 Discord 机器人通知 keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 +> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 -### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token +### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token -1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 +1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 ![bot](/img/docs/help/discord-bot-1.png) -2. 在应用下创建机器人，获取机器人 Token +2. 在应用下创建机器人，获取机器人 Token ![bot](/img/docs/help/discord-bot-2.png) ![bot](/img/docs/help/discord-bot-3.png) -3. 授权机器人到聊天服务器 +3. 授权机器人到聊天服务器 -> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` +> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` ![bot](/img/docs/help/discord-bot-4.png) > 获取到最下方生成的 URL, 浏览器访问此 URL 给机器人正式授权，即设置将机器人加入哪个聊天服务器。 -4. 查看您的聊天服务器是否已经加入机器人成员 +4. 查看您的聊天服务器是否已经加入机器人成员 ![bot](/img/docs/help/discord-bot-5.png) -### 开启开发者模式，获取频道 Channel ID +### 开启开发者模式，获取频道 Channel ID -1. 个人设置 -> 高级设置 -> 开启开发者模式 +1. 个人设置 -> 高级设置 -> 开启开发者模式 ![bot](/img/docs/help/discord-bot-6.png) -2. 获取频道 Channel ID +2. 获取频道 Channel ID -> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID +> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID ![bot](/img/docs/help/discord-bot-7.png) - -### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot +### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot 1. **【告警通知】->【新增接收人】 ->【选择 Discord 机器人通知方式】->【设置机器人Token和ChannelId】-> 【确定】** ![email](/img/docs/help/discord-bot-8.png) -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -![email](/img/docs/help/alert-notice-policy.png) +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +![email](/img/docs/help/alert-notice-policy.png) -### Discord 机器人通知常见问题 +### Discord 机器人通知常见问题 -1. Discord 未收到机器人告警通知 +1. Discord 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 > 请排查机器人是否被 Discord聊天服务器正确赋权 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md index 7033f6036d6..d4dc218c591 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md @@ -5,34 +5,35 @@ sidebar_label: 告警邮件通知 keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过邮件通知到接收人。 +> 阈值触发后发送告警信息，通过邮件通知到接收人。 -### 操作步骤 +### 操作步骤 -1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** +1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** -![email](/img/docs/help/alert-notice-1.png) +![email](/img/docs/help/alert-notice-1.png) 2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** -![email](/img/docs/help/alert-notice-2.png) + ![email](/img/docs/help/alert-notice-2.png) -![email](/img/docs/help/alert-notice-3.png) +![email](/img/docs/help/alert-notice-3.png) -3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 邮件通知常见问题 -### 邮件通知常见问题 +1. 自己内网部署的HertzBeat无法接收到邮件通知 -1. 自己内网部署的HertzBeat无法接收到邮件通知 -> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 +> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 + +2. 云环境TanCloud无法接收到邮件通知 -2. 云环境TanCloud无法接收到邮件通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确邮箱，是否已配置告警策略关联 -> 请查询邮箱的垃圾箱里是否把告警邮件拦截 +> 请查询邮箱的垃圾箱里是否把告警邮件拦截 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群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 index 3f1c5a2b9c1..b70c8b10c40 100644 --- 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 @@ -5,28 +5,28 @@ sidebar_label: 企业微信应用告警通知 keywords: [开源告警系统, 开源监控告警系统, 企业微信应用告警通知] --- -> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. +> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. -### Operation steps +### Operation steps 1. **【企业微信后台管理】-> 【App管理】-> 【创建一个新的应用】-> 【设置应用信息】->【添加成功后复制应用的AgentId和Secret】** -![email](/img/docs/help/alert-wechat-1.jpg) +![email](/img/docs/help/alert-wechat-1.jpg) 2. **【告警通知】->【新增接收人】 ->【选择企业微信应用通知方式】->【设置企业ID,企业应用id和应用的secret 】-> 【确定】** ![email](/img/docs/help/alert-wechat-2.jpg) -3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** -![email](/img/docs/help/alert-wechat-3.jpg) +![email](/img/docs/help/alert-wechat-3.jpg) +### 企业微信应用通知常见问题 -### 企业微信应用通知常见问题 +1. 企业微信应用未收到告警通知. -1. 企业微信应用未收到告警通知. > 请检查用户是否具有应用程序权限. > 请检查企业应用程序回调地址设置是否正常. > 请检查服务器IP是否在企业应用程序白名单上. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md index 448e70de223..604eff34fdc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md @@ -5,30 +5,30 @@ sidebar_label: 告警飞书机器人通知 keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 +> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 -### 操作步骤 +### 操作步骤 1. **【飞书客户端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** -2. **【保存机器人的WebHook地址的KEY值】** +2. **【保存机器人的WebHook地址的KEY值】** > 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 飞书机器人通知常见问题 -### 飞书机器人通知常见问题 +1. 飞书群未收到机器人告警通知 -1. 飞书群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 +> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md index e137d07e9e2..c81f5608674 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md @@ -5,34 +5,33 @@ sidebar_label: 告警 Slack Webhook 通知 keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 +> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 -### 在 Slack 开启 Webhook, 获取 Webhook URL +### 在 Slack 开启 Webhook, 获取 Webhook URL -参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) +参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) -### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook +### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook 1. **【告警通知】->【新增接收人】 ->【选择 Slack Webhook 通知方式】->【设置 Webhook URL】-> 【确定】** ![email](/img/docs/help/slack-bot-1.png) -2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 -![email](/img/docs/help/alert-notice-policy.png) +![email](/img/docs/help/alert-notice-policy.png) +### Slack 机器人通知常见问题 -### Slack 机器人通知常见问题 - -1. Slack 未收到机器人告警通知 +1. Slack 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 +> 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群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 index 6730aa19dcb..df609e66b50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md @@ -5,22 +5,22 @@ sidebar_label: 告警 Telegram 机器人通知 keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 +> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 ### 在 Telegram 创建机器人, 获取 Bot Token 和 UserId -1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` +1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` ![telegram-bot](/img/docs/help/telegram-bot-1.png) -2. 获取接收人的 `User ID` +2. 获取接收人的 `User ID` -**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, -访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` +**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, +访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` ```json { @@ -42,27 +42,26 @@ keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] } ``` -3. 记录保存我们获得的 `Token` 和 `User Id` +3. 记录保存我们获得的 `Token` 和 `User Id` -### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot +### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot 1. **【告警通知】->【新增接收人】 ->【选择 Telegram 机器人通知方式】->【设置机器人Token和UserId】-> 【确定】** ![email](/img/docs/help/telegram-bot-2.png) -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 -![email](/img/docs/help/alert-notice-policy.png) +![email](/img/docs/help/alert-notice-policy.png) +### Telegram 机器人通知常见问题 -### Telegram 机器人通知常见问题 - -1. Telegram 未收到机器人告警通知 +1. Telegram 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 -> UserId 应为消息接收对象的UserId +> UserId 应为消息接收对象的UserId -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md index 42a711c5916..2f8bda93e2b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md @@ -1,18 +1,18 @@ --- id: alert_threshold title: 阈值告警配置 -sidebar_label: 阈值告警配置 +sidebar_label: 阈值告警配置 --- -> 对监控指标配置告警阈值(警告告警，严重告警，紧急告警)，系统根据阈值配置和采集指标数据计算触发告警。 +> 对监控指标配置告警阈值(警告告警，严重告警，紧急告警)，系统根据阈值配置和采集指标数据计算触发告警。 -### 操作步骤 +### 操作步骤 -1. **【告警配置】->【新增阈值】-> 【配置后确定】** +1. **【告警配置】->【新增阈值】-> 【配置后确定】** -![threshold](/img/docs/help/alert-threshold-1.png) +![threshold](/img/docs/help/alert-threshold-1.png) -如上图： +如上图： **指标对象**：选择我们需要配置阈值的监控指标对象 例如：网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标 **阈值触发表达式**：根据此表达式来计算判断是否触发阈值，表达式环境变量和操作符见页面提示，例如：设置响应时间大于50触发告警，表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr) @@ -20,17 +20,17 @@ sidebar_label: 阈值告警配置 **触发次数**：设置触发阈值多少次之后才会真正的触发告警 **通知模版**：告警触发后发送的通知信息模版,模版环境变量见页面提示，例如：`${app}.${metrics}.${metric}指标的值为${responseTime}，大于50触发告警` **全局默认**： 设置此阈值是否对全局的此类指标都应用有效，默认否。新增阈值后还需将阈值与监控对象关联，这样阈值才会对此监控生效。 -**启用告警**：此告警阈值配置开启生效或关闭 +**启用告警**：此告警阈值配置开启生效或关闭 -2. ** 阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】** +2. ** 阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】** -> ** 注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效)，这样阈值才会对此监控生效 **。 +> ** 注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效)，这样阈值才会对此监控生效 **。 -![threshold](/img/docs/help/alert-threshold-2.png) +![threshold](/img/docs/help/alert-threshold-2.png) -![threshold](/img/docs/help/alert-threshold-3.png) +![threshold](/img/docs/help/alert-threshold-3.png) **阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。** -**若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。** +**若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。** -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md index 14fbcdb13dc..a3c5fe9a1c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md @@ -1,12 +1,12 @@ --- id: alert_threshold_expr title: 阈值触发表达式 -sidebar_label: 阈值触发表达式 +sidebar_label: 阈值触发表达式 --- -> 在我们配置阈值告警时，需要配置阈值触发表达式，系统根据表达式和监控指标值计算触发是否告警，这里详细介绍下表达式使用。 +> 在我们配置阈值告警时，需要配置阈值触发表达式，系统根据表达式和监控指标值计算触发是否告警，这里详细介绍下表达式使用。 -#### 表达式支持的操作符 +#### 表达式支持的操作符 ``` equals(str1,str2) @@ -24,30 +24,31 @@ equals(str1,str2) ``` 丰富的操作符让我们可以很自由的定义表达式。 -注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 != +注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 != #### 表达式函数库列表 参考: https://www.yuque.com/boyan-avfmj/aviatorscript/ashevw -#### 支持的环境变量 -> 环境变量即指标值等支持的变量，用于在表达式中，阈值计算判断时会将变量替换成实际值进行计算 +#### 支持的环境变量 + +> 环境变量即指标值等支持的变量，用于在表达式中，阈值计算判断时会将变量替换成实际值进行计算 非固定环境变量：这些变量会根据我们选择的监控指标对象而动态变化，例如我们选择了**网站监控的响应时间指标**，则环境变量就有 `responseTime - 此为响应时间变量` 如果我们想设置**网站监控的响应时间大于400时**触发告警，则表达式为 `responseTime>400` 固定环境变量(不常用)：`instance : 所属行实例值` -此变量主要用于计算多实例时，比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警，则表达式为 `equals(instance,"c")&&usage>80` +此变量主要用于计算多实例时，比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警，则表达式为 `equals(instance,"c")&&usage>80` -#### 表达式设置案例 +#### 表达式设置案例 1. 网站监控->响应时间大于等于400ms时触发告警 -`responseTime>=400` + `responseTime>=400` 2. API监控->响应时间大于3000ms时触发告警 -`responseTime>3000` + `responseTime>3000` 3. 全站监控->URL(instance)路径为 `https://baidu.com/book/3` 的响应时间大于200ms时触发告警 -`equals(instance,"https://baidu.com/book/3")&&responseTime>200` + `equals(instance,"https://baidu.com/book/3")&&responseTime>200` 4. MYSQL监控->status指标->threads_running(运行线程数)指标大于7时触发告警 -`threads_running>7` + `threads_running>7` -若遇到问题可以通过交流群ISSUE交流反馈哦！ +若遇到问题可以通过交流群ISSUE交流反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md index 61ed1dc99b5..022cd50f07e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md @@ -5,23 +5,24 @@ sidebar_label: 告警 Webhook 回调通知 keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 +> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 -## 操作步骤 +## 操作步骤 -1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** +1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** ![email](/img/docs/help/alert-notice-5.png) -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) -### WebHook回调POST请求体BODY内容 +### WebHook回调POST请求体BODY内容 + +内容格式：JSON -内容格式：JSON ```json { "alarmId": 76456, @@ -43,22 +44,23 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 } ``` -| | | -|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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} | +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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通知常见问题 -### webhook通知常见问题 +1. WebHook回调未生效 -1. WebHook回调未生效 > 请查看告警中心是否已经产生此条告警信息 > 请排查配置的WebHook回调地址是否正确 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md index ce73c131d00..e0dbabf1a70 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md @@ -5,34 +5,34 @@ sidebar_label: 告警企业微信通知 keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 +> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 -### 操作步骤 +### 操作步骤 -1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** +1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** -![email](/img/docs/help/alert-notice-6.jpg) +![email](/img/docs/help/alert-notice-6.jpg) -2. **【保存机器人的WebHook地址的KEY值】** +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` +> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** +3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** ![email](/img/docs/help/alert-notice-7.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 企业微信机器人通知常见问题 -### 企业微信机器人通知常见问题 +1. 企业微信群未收到机器人告警通知 -1. 企业微信群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 +> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md index caa4b9f51fd..88f0e690223 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md @@ -5,32 +5,31 @@ sidebar_label: HTTP API keywords: [开源监控系统, 开源网站监控, HTTP API监控] --- -> 调用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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------------|-------------------------------------------------------------------| +| 监控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毫秒 | 网站响应时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md index 03c514bc7b8..3d0654db3b5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| 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 index cdd9f6f6ee5..ea4a376c049 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md @@ -9,41 +9,41 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5236。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5236。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------------ | -| PORT_NUM | 无 | 数据库暴露服务端口 | -| CTL_PATH | 无 | 控制文件路径 | -| MAX_SESSIONS | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|-----------| +| PORT_NUM | 无 | 数据库暴露服务端口 | +| CTL_PATH | 无 | 控制文件路径 | +| MAX_SESSIONS | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------ | -| status$ | 无 | DM数据库的开闭状态 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|------------| +| status$ | 无 | DM数据库的开闭状态 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | ---------------------------------------------- | -| dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | -| dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | -| dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------------------------| +| dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | +| dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | +| dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md index 221776b2426..c546b46fd2c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md @@ -7,7 +7,6 @@ keywords: [开源监控系统, 开源容器监控, Docker容器监控] > 对Docker容器的通用性能指标进行采集监控。 - ## 监控前操作 如果想要监控 `Docker` 中的容器信息，则需要按照一下步骤打开端口，让采集请求获取到对应的信息。 @@ -44,63 +43,60 @@ 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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 系统时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------------------------------| +| 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容器中的更新时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| 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使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|--------------------| +| 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 index e3e143c17ed..8c2f1e290e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md @@ -7,15 +7,15 @@ keywords: [开源监控系统, 开源中间件监控, DynamicTp线程池监控] > 对DynamicTp actuator 暴露的线程池性能指标进行采集监控。 -### 前提 +### 前提 -1. 集成使用 `DynamicTp` +1. 集成使用 `DynamicTp` `DynamicTp` 是Jvm语言的基于配置中心的轻量级动态线程池，内置监控告警功能，可通过SPI自定义扩展实现。 -集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) +集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) -2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 +2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 ```yaml management: @@ -24,7 +24,8 @@ management: exposure: include: '*' ``` -测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: + +测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: ```json [ @@ -58,45 +59,44 @@ management: ] ``` -3. 在HertzBeat中间件监控下添加DynamicTp监控即可 - +3. 在HertzBeat中间件监控下添加DynamicTp监控即可 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口，默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | - | Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 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 | 无 | 等待超时任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|--------------------------| +| 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 index f7fc4c150b7..9d39da7c9e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md @@ -7,29 +7,29 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] > 对网站的全部页面监测是否可用 > 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 -> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 +> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 网站地图 | 网站SiteMap地图地址的相对路径，例如：/sitemap.xml。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 监控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 | 无 | 请求此网站反馈的错误信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|-----------------| +| 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 index 7d177cfe868..0670d75a984 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md @@ -1,84 +1,83 @@ --- id: guide title: 帮助中心 -sidebar_label: 帮助入门 +sidebar_label: 帮助入门 --- > 易用友好的实时监控工具，无需Agent，强大自定义监控能力。 -> 使用过程中的帮助文档,辅助信息。 +> 使用过程中的帮助文档,辅助信息。 ## 🔬 监控服务 > 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 > 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 -### 应用服务监控 +### 应用服务监控 -  👉 [网站监测](website)
-  👉 [HTTP API](api)
-  👉 [PING连通性](ping)
-  👉 [端口可用性](port)
-  👉 [全站监控](fullsite)
-  👉 [SSL证书有效期](ssl_cert)
-  👉 [JVM虚拟机](jvm)
-  👉 [SpringBoot2.0](springboot2)
+ 👉 [网站监测](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)
+ 👉 [MYSQL数据库监控](mysql)
+ 👉 [MariaDB数据库监控](mariadb)
+ 👉 [PostgreSQL数据库监控](postgresql)
+ 👉 [SqlServer数据库监控](sqlserver)
+ 👉 [Oracle数据库监控](oracle)
+ 👉 [达梦数据库监控](dm)
+ 👉 [OpenGauss数据库监控](opengauss)
+ 👉 [IoTDB数据库监控](iotdb)
-### 操作系统监控 +### 操作系统监控 -  👉 [Linux操作系统监控](linux)
-  👉 [Windows操作系统监控](windows)
-  👉 [Ubuntu操作系统监控](ubuntu)
-  👉 [Centos操作系统监控](centos)
+ 👉 [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)
+ 👉 [Zookeeper](zookeeper)
+ 👉 [Kafka](kafka)
+ 👉 [Tomcat](tomcat)
+ 👉 [ShenYu](shenyu)
+ 👉 [DynamicTp](dynamic_tp)
+ 👉 [RabbitMQ](rabbitmq)
+ 👉 [ActiveMQ](activemq)
+ 👉 [Jetty](jetty)
### 云原生监控 -  👉 [Docker](docker)
-  👉 [Kubernetes](kubernetes)
+ 👉 [Docker](docker)
+ 👉 [Kubernetes](kubernetes)
-## 💡 告警服务 +## 💡 告警服务 > 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 -> 告警服务的定位是阈值准确及时触发，告警通知及时可达。 +> 告警服务的定位是阈值准确及时触发，告警通知及时可达。 -### 告警中心 +### 告警中心 -> 已触发的告警信息中心，提供告警删除，告警处理，标记未处理，告警级别状态等查询过滤。 +> 已触发的告警信息中心，提供告警删除，告警处理，标记未处理，告警级别状态等查询过滤。 -### 告警配置 +### 告警配置 > 指标阈值配置，提供表达式形式的指标阈值配置，可设置告警级别，触发次数，告警通知模版和是否启用，关联监控等功能。 详见 👉 [阈值告警](alert_threshold)
-   👉 [阈值表达式](alert_threshold_expr) +   👉 [阈值表达式](alert_threshold_expr) -### 告警通知 +### 告警通知 > 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 > 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 -> 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。 - +> 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。  👉 [配置邮箱通知](alert_email)
 👉 [配置 Webhook 通知](alert_webhook)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md index fec361e2366..bda83b006e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md @@ -37,57 +37,54 @@ export HADOOP_OPTS= "$HADOOP_OPTS ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache (限JDK8及以下) -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| 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 index 2c2136f91cf..3b41d3979c6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md @@ -16,6 +16,7 @@ keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hi ```shell hive --service metastore & ``` + **2. 启用 Hive Server2:** ```shell @@ -24,54 +25,53 @@ hive --service hiveserver2 & ### 配置参数 -| 参数名称 | 参数描述 | -| ---------- |--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 10002。 | -| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 参数名称 | 参数描述 | +|----------|--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 10002。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 #### 指标收集: 基本信息 -| 指标名称 | 指标单位 | 指标描述 | -|--------|-------|-----------------------------| -| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | -| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | -| 虚拟机版本 | 无 | 虚拟机的版本。 | -| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | +| 指标名称 | 指标单位 | 指标描述 | +|--------|------|-----------------------------| +| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | +| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | +| 虚拟机版本 | 无 | 虚拟机的版本。 | +| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | #### 指标收集: 环境信息 -| 指标名称 | 指标单位 | 指标描述 | -|------------|-------|--------------------------------| -| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | -| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | -| 操作系统版本 | 无 | 操作系统的版本。 | -| 操作系统架构 | 无 | 操作系统的架构。 | -| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | -| java运行环境版本 | 无 | Java 运行时环境的版本。 | +| 指标名称 | 指标单位 | 指标描述 | +|------------|------|--------------------------------| +| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | +| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | +| 操作系统版本 | 无 | 操作系统的版本。 | +| 操作系统架构 | 无 | 操作系统的架构。 | +| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | +| java运行环境版本 | 无 | Java 运行时环境的版本。 | #### 指标收集: 线程信息 -| 指标名称 | 指标单位 | 指标描述 | +| 指标名称 | 指标单位 | 指标描述 | |--------|------|------------------------------| | 线程数量 | None | HiveServer2 当前正在使用的线程数。 | -| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | +| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | | 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 | | 守护线程数 | None | HiveServer2 当前活动的守护线程数。 | #### 指标收集: 代码缓存 -| 指标名称 | 指标单位 | 指标描述 | -|------------|-------------|---------------| -| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | -| 内存池初始内存 | MB | 内存池请求的初始内存量。 | -| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | -| 内存池内存使用量 | MB | 内存池已使用内存量 | - +| 指标名称 | 指标单位 | 指标描述 | +|------------|------|---------------| +| 内存池当前内存 | 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 index 0f0dc0e0ecb..fceb485f05b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md @@ -5,15 +5,15 @@ sidebar_label: IoTDB数据库 keywords: [开源监控系统, 开源数据库监控, IoTDB数据库监控] --- -> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 +> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 -## 监控前操作 +## 监控前操作 -您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 +您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 -开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) +开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) -主要如下步骤: +主要如下步骤: 1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server @@ -41,13 +41,13 @@ predefinedMetrics: - FILE ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 3. 在 HertzBeat 添加对应 IoTDB 监控即可。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -57,37 +57,37 @@ predefinedMetrics: | 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | | 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：cluster_node_status +#### 指标集合：cluster_node_status -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- |------|-------------------------| +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-------------------------| | name | 无 | 节点名称IP | | status | 无 | 节点状态，1=online 2=offline | #### 指标集合：jvm_memory_committed_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|------------------| | area | 无 | heap内存或nonheap内存 | | id | 无 | 内存区块 | -| value | MB | 当前向JVM申请的内存大小 | +| value | MB | 当前向JVM申请的内存大小 | #### 指标集合：jvm_memory_used_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| | area | 无 | heap内存或nonheap内存 | | id | 无 | 内存区块 | -| value | MB | JVM已使用内存大小 | +| value | MB | JVM已使用内存大小 | #### 指标集合：jvm_threads_states_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------| -| state | 无 | 线程状态 | -| count | 无 | 线程状态对应线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------| +| state | 无 | 线程状态 | +| count | 无 | 线程状态对应线程数量 | #### 指标集合：quantity 业务数据 @@ -99,22 +99,23 @@ predefinedMetrics: #### 指标集合：cache_hit 缓存 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------------------------------------------------| -| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | -| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------| +| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | +| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | #### 指标集合：queue 任务队列 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|---------------------------------------------------| -| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | -| status | 无 | 状态 running/waiting | -| value | 无 | 当前时间任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|----------------------------------------------| +| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | +| status | 无 | 状态 running/waiting | +| value | 无 | 当前时间任务数 | #### 指标集合：thrift_connections -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-------------| -| name | 无 | 名称 | -| connection | 无 | thrift当前连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|-------------| +| name | 无 | 名称 | +| connection | 无 | thrift当前连接数 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md index 6dbfc73a7f2..c62c6f9448a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md @@ -1,62 +1,70 @@ --- id: issue title: 常见问题 -sidebar_label: 常见问题 +sidebar_label: 常见问题 --- -### 监控常见问题 +### 监控常见问题 -1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** -> 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http +1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** -2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK ** -> 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在) +> 如信息所示，输入的监控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是可用的。 + 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + +4. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖服务TDengine时序数据库] -4. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖服务TDengine时序数据库] > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - TDengine数据库 -> 安装初始化此数据库参考 [TDengine安装初始化](../start/tdengine-init) +> 安装初始化此数据库参考 [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”，服务器没有转义导致鉴权失败，建议转义功能作为可选项。 - +> 6.配置http api监控，用于进行业务接口探测，确保业务可以用，另外接口有进行token鉴权校验，"Authorization：Bearer eyJhbGciOiJIUzI1...."，配置后测试，提示“StatusCode 401”。服务端应用收到的token为"Authorization：Bearer%20eyJhbGciOiJIUzI1....",hertzbeat对空格进行转义为“%20”，服务器没有转义导致鉴权失败，建议转义功能作为可选项。 -### Docker部署常见问题 +### Docker部署常见问题 1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** -此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + > 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` +> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` 2. **按照流程部署，访问 http://ip:1157/ 无界面** -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 -3. **日志报错TDengine连接或插入SQL失败** +3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter ### 安装包部署常见问题 1. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md index 04a15823529..b60a5882b9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md @@ -15,17 +15,18 @@ keywords: [开源监控系统, 开源中间件监控, Jetty应用服务器监控 #### Jetty应用服务器开启JMX协议步骤 -[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) +[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) -1. 在 Jetty 启动 JMX 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 端口等参数。 +命令执行成功会创建出 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件 + +2. 编辑 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件，修改 JMX 的 IP 端口等参数。 **`localhost` 需修改为对外暴露 IP** @@ -50,49 +51,45 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| 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 index c97cc73b003..f046b3ef6a0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md @@ -28,57 +28,54 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache (限JDK8及以下) -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| 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 index 2b4ed0514b7..3cb4d74132c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md @@ -7,7 +7,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] > 对Kafka的通用性能指标进行采集监控 -**使用协议：JMX** +**使用协议：JMX** ### 监控前操作 @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` -在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 +在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell export JMX_PORT=9999; @@ -32,71 +32,65 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：server_info -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Version | 无 | Kafka版本 | -| StartTimeMs | ms | 运行时间 | -| CommitId | 无 | 版本提交ID | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------| +| Version | 无 | Kafka版本 | +| StartTimeMs | ms | 运行时间 | +| CommitId | 无 | 版本提交ID | #### 指标集合：code_cache -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：active_controller_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 活跃监控器数量 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------| +| Value | 个 | 活跃监控器数量 | #### 指标集合：broker_partition_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 分区数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------| +| Value | 个 | 分区数量 | #### 指标集合：broker_leader_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 领导者数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------| +| Value | 个 | 领导者数量 | #### 指标集合：broker_handler_avg_percent 请求处理器空闲率 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| EventType | 无 | 类型 | -| RateUnit | 具体情况具体分析 | 单位 | -| Count | 个 | 数量 | -| OneMinuteRate | % | 一分钟处理率 | -| FiveMinuteRate | % | 五分钟处理率 | -| MeanRate | 无 | 平均处理率 | -| FifteenMinuteRate | 无 | 十五分钟处理率 | - - -> 其他指标见文知意，欢迎贡献一起优化文档。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|----------|---------| +| 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 index f45da8d9b27..aa242d93a6b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md @@ -7,14 +7,13 @@ keywords: [开源监控系统, 开源Kubernetes监控] > 对kubernetes的通用性能指标进行采集监控。 - ## 监控前操作 如果想要监控 `Kubernetes` 中的信息，则需要获取到可访问Api Server的授权TOKEN，让采集请求获取到对应的信息。 -参考获取token步骤 +参考获取token步骤 -#### 方式一: +#### 方式一: 1. 创建service account并绑定默认cluster-admin管理员集群角色 @@ -27,7 +26,9 @@ kubectl create clusterrolebinding dashboard-admin --clusterrole=cluster-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 @@ -36,13 +37,14 @@ kubectl create clusterrolebinding cluster-admin-manual --clusterrole=cluster-adm kubectl create token --duration=1000h cluster-admin ``` + ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| APiServer端口 | K8s APiServer端口，默认6443 | +| APiServer端口 | K8s APiServer端口，默认6443 | | token | 授权Access Token | | URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | | 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | @@ -53,44 +55,45 @@ kubectl create token --duration=1000h cluster-admin #### 指标集合：nodes -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- |--------| -| node_name | 无 | 节点名称 | -| is_ready | 无 | 节点状态 | -| capacity_cpu | 无 | CPU容量 | -| allocatable_cpu | 无 | 已分配CPU | -| capacity_memory | 无 | 内存容量 | -| allocatable_memory | 无 | 已分配内存 | -| creation_time | 无 | 节点创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------| +| node_name | 无 | 节点名称 | +| is_ready | 无 | 节点状态 | +| capacity_cpu | 无 | CPU容量 | +| allocatable_cpu | 无 | 已分配CPU | +| capacity_memory | 无 | 内存容量 | +| allocatable_memory | 无 | 已分配内存 | +| creation_time | 无 | 节点创建时间 | #### 指标集合：namespaces -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- |-------------| -| namespace | 无 | namespace名称 | -| status | 无 | 状态 | -| creation_time | 无 | 创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-------------| +| 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启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|----------------| +| 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 | 无 | 创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|--------------------------------------------------------| +| 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 index 853be6610b4..4a69c04495e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| 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 index 5fd59466717..2490e3630dd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md @@ -9,49 +9,46 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|------------| +| version | 无 | 数据库版本 | +| port | 无 | 数据库暴露服务端口 | +| datadir | 无 | 数据库存储数据盘地址 | +| max_connections | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| threads_created | 无 | MariaDB已经创建的总连接数 | -| threads_connected | 无 | MariaDB已经连接的连接数 | -| threads_cached | 无 | MariaDB当前缓存的连接数 | -| threads_running | 无 | MariaDB当前活跃的连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|------------------| +| 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 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|-------------------------| +| 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 index 5d89ce0977b..920da021e6b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 You need to use the stats command to view the parameters that your memcache can monitor ``` -### +### **1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. @@ -36,7 +36,7 @@ STAT version 1.4.15 ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -49,7 +49,7 @@ STAT version 1.4.15 #### Metrics Set：server_info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|---------------------------------------------------| | pid | | Memcache server process ID | | uptime | s | The number of seconds the server has been running | @@ -66,4 +66,5 @@ STAT version 1.4.15 | cmd_set | | Set command request count | | cmd_flush | | Flush command request count | | get_misses | | Get command misses | -| delete_misses | | Delete command misses | \ No newline at end of file +| delete_misses | | Delete command misses | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md index dc23f3d6fa5..c5deaab27a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md @@ -9,49 +9,46 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|------------| +| version | 无 | 数据库版本 | +| port | 无 | 数据库暴露服务端口 | +| datadir | 无 | 数据库存储数据盘地址 | +| max_connections | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| threads_created | 无 | MySql已经创建的总连接数 | -| threads_connected | 无 | MySql已经连接的连接数 | -| threads_cached | 无 | MySql当前缓存的连接数 | -| threads_running | 无 | MySql当前活跃的连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|----------------| +| 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 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|-------------------------| +| 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 index d070101da8f..ded4a06ad2f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md @@ -14,7 +14,7 @@ keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGr nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 ``` -### +### **1、通过 stats 和 rocksdb stats 接口获取可用参数。** @@ -34,7 +34,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-------------|--------------------------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️没有协议头（例如：https://、http://） | | 监控名称 | 识别此监控的名称。名称需要唯一 | @@ -53,7 +53,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 指标太多，相关链接如下 **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------------------------------------------|------|--------| | 达到内存水位线的语句的数量(rate) | | | | 达到内存水位线的语句的数量(sum) | | | @@ -116,8 +116,9 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 指标太多，相关链接如下 **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------|------|------------------------| | rocksdb.backup.read.bytes | | 备份 RocksDB 数据库期间读取的字节数 | | rocksdb.backup.write.bytes | | 指标名称 | | ... | | ... | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md index a509ff7da2a..82908df358b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md @@ -13,18 +13,19 @@ keywords: [开源监控工具, 开源Java监控工具, 监控Nginx指标] 如果你想使用这种监控方式监控 'Nginx' 的信息，你需要修改你的 Nginx 配置文件以启用监控模块。 -### 启用 ngx_http_stub_status_module +### 启用 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 并解压，在目录下执行 +下载 Nginx 并解压，在目录下执行 ```shell ./configure --prefix=/usr/local/nginx --with-http_stub_status_module @@ -58,7 +59,7 @@ nginx -s reload 5. 在浏览器访问 `http://localhost/nginx-status` 即可查看 Nginx 监控状态信息。 -### 启用 `ngx_http_reqstat_module` +### 启用 `ngx_http_reqstat_module` 1. 安装 `ngx_http_reqstat_module` 模块 @@ -107,49 +108,47 @@ nginx -s reload 4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 - **参考文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** **⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** ### 配置参数 -| 参数名 | 参数描述 | -|-------------------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | Nginx 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | +| 参数名 | 参数描述 | +|--------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | Nginx 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | ### 收集指标 #### 指标收集：nginx_status -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------------|------------| -| 接收连接数 | | 已接受的连接 | -| 处理连接数 | | 成功处理的连接 | -| 活动连接数 | | 当前活动连接 | -| 丢弃连接数 | | 丢弃的连接 | -| 请求连接数 | | 客户端请求 | -| 读连接数 | | 正在执行读操作的连接 | -| 写连接数 | | 正在执行写操作的连接 | -| 等待连接数 | | 等待连接 | +| 指标名称 | 指标单位 | 指标描述 | +|-------|------|------------| +| 接收连接数 | | 已接受的连接 | +| 处理连接数 | | 成功处理的连接 | +| 活动连接数 | | 当前活动连接 | +| 丢弃连接数 | | 丢弃的连接 | +| 请求连接数 | | 客户端请求 | +| 读连接数 | | 正在执行读操作的连接 | +| 写连接数 | | 正在执行写操作的连接 | +| 等待连接数 | | 等待连接 | #### 指标集：req_status -| 指标名称 | 指标单位 | 指标描述 | -|---------|-------|---------| -| 分组类别 | | 分组类别 | -| 分组名称 | | 分组名称 | -| 最大并发连接数 | | 最大并发连接数 | -| 最大带宽 | kb | 最大带宽 | -| 总流量 | kb | 总流量 | -| 总请求数 | | 总请求数 | -| 当前并发连接数 | | 当前并发连接数 | -| 当前带宽 | kb | 当前带宽 | - +| 指标名称 | 指标单位 | 指标描述 | +|---------|------|---------| +| 分组类别 | | 分组类别 | +| 分组名称 | | 分组名称 | +| 最大并发连接数 | | 最大并发连接数 | +| 最大带宽 | 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 index 5760321922f..735ab741b4d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md @@ -15,7 +15,7 @@ NTP监控的中文文档如下： ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------|--------------------------------------------------| | 监控主机 | 被监控的IPv4、IPv6或域名。注意⚠️不包含协议头（例如：https://，http://） | | 监控名称 | 标识此监控的名称。名称需要是唯一的 | @@ -27,7 +27,7 @@ NTP监控的中文文档如下： #### 指标集：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|------|--------------------------| | 响应时间 | 毫秒 | NTP服务器响应请求所需的时间。 | | 时间 | 毫秒 | NTP服务器报告的当前时间。 | @@ -39,3 +39,4 @@ NTP监控的中文文档如下： | 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 | | 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | | 精度 | | NTP服务器时钟的精度，表示其准确性。 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md index 632a7f41b2d..8bf21d7debb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md @@ -9,50 +9,48 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| 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 | 无 | 这些统计信息上次被重置的时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | #### 指标集合：activity -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| running | 连接数 | 当前客户端连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md index 49136e51c48..7ffdfa219ff 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md @@ -9,55 +9,56 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1521。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 数据库状态 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|---------| +| database_version | 无 | 数据库版本 | +| database_type | 无 | 数据库类型 | +| hostname | 无 | 主机名称 | +| instance_name | 无 | 数据库实例名称 | +| startup_time | 无 | 数据库启动时间 | +| status | 无 | 数据库状态 | #### 指标集合：tablespace -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| file_id | 无 | 文件ID | -| file_name | 无 | 文件名称 | -| tablespace_name | 无 | 所属表空间名称 | -| status | 无 | 状态 | -| bytes | MB | 大小 | -| blocks | 无 | 区块数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------| +| file_id | 无 | 文件ID | +| file_name | 无 | 文件名称 | +| tablespace_name | 无 | 所属表空间名称 | +| status | 无 | 状态 | +| bytes | MB | 大小 | +| blocks | 无 | 区块数量 | #### 指标集合：user_connect -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| username | 无 | 用户名 | -| counts | 个数 | 当前连接数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| 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 兆字节数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|------|---------------------------------------| +| qps | QPS | I/O Requests per Second 每秒IO请求数量 | +| tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 | +| mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md index 7b6613f25bd..401e86f9382 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md @@ -5,32 +5,33 @@ sidebar_label: PING连通性 keywords: [开源监控系统, 开源网络监控, 网络PING监控] --- -> 对对端HOST地址进行PING操作，判断其连通性 +> 对对端HOST地址进行PING操作，判断其连通性 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | - -### 常见问题 +### 常见问题 1. 安装包部署的hertzbeat下ping连通性监控异常 - 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md index 8d6c2eb5548..4c58cc4a308 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md @@ -24,26 +24,24 @@ keywords: [开源监控工具，开源Java监控工具，监控POP3指标] 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 ``` - ### 配置参数 -| 参数名 | 参数描述 | -|-------------------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | POP3 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | +| 参数名 | 参数描述 | +|--------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | POP3 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | ### 采集指标 #### 指标集：email_status -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------| -| 邮件数量 | | 邮件数量 | -| 邮箱总大小 | kb | 邮箱中邮件的总大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------| +| 邮件数量 | | 邮件数量 | +| 邮箱总大小 | kb | 邮箱中邮件的总大小 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md index b89fde24a81..88dc6360cd3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md @@ -9,22 +9,21 @@ keywords: [开源监控系统, 开源网络监控, 端口可用性监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md index 4716d0e2e64..59adae7da81 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md @@ -9,50 +9,48 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| 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 | 无 | 这些统计信息上次被重置的时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | #### 指标集合：activity -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| running | 连接数 | 当前客户端连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md index 8cb91eeb3e6..89c728162c9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md @@ -5,42 +5,42 @@ sidebar_label: RabbitMQ消息中间件 keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间件监控] --- -> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 +> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 -### 监控前操作 +### 监控前操作 > HertzBeat 使用 RabbitMQ Management 的 Rest Api 对 RabbitMQ 进行指标数据采集。 -> 故需要您的 RabbitMQ 环境开启 Management 插件 +> 故需要您的 RabbitMQ 环境开启 Management 插件 -1. 开启 Management 插件，或使用自开启版本 +1. 开启 Management 插件，或使用自开启版本 ```shell rabbitmq-plugins enable rabbitmq_management ``` -2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 +2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -|----------|---------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | -| 用户名 | 接口Basic认证时使用的用户名 | -| 密码 | 接口Basic认证时使用的密码 | -| 超时时间 | HTTP请求查询超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | +| 用户名 | 接口Basic认证时使用的用户名 | +| 密码 | 接口Basic认证时使用的密码 | +| 超时时间 | HTTP请求查询超时时间 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：overview +#### 指标集合：overview -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------------|------|--------------------------| | product_version | 无 | 产品版本 | | product_name | 无 | 产品名称 | @@ -52,7 +52,7 @@ rabbitmq-plugins enable rabbitmq_management #### 指标集合：object_totals -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-----------------| | channels | 无 | channels的总数量 | | connections | 无 | connections的总数量 | @@ -62,65 +62,65 @@ rabbitmq-plugins enable rabbitmq_management #### 指标集合：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 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|-------------------------------| +| 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. | +| 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. | +| 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 | +| vhost | 无 | vhost path | | auto_delete | 无 | Whether the queue will be deleted automatically when no longer used | -| policy | 无 | Effective policy name for the queue. | +| 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_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_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 | 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_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md index dd9b304e1ce..58248fb0b45 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md @@ -2,244 +2,239 @@ id: redis title: 监控：REDIS数据库监控 sidebar_label: REDIS数据库 -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] --- > 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|-----------------------------------------------| +| 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 | 无 | 客户端超时表中的客户端数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|--------------------------------------------------------------------------------| +| 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 | 无 | 已延迟释放的对象数。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|----------|-----------------------------------------------------------------------------------------------| +| 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操作期间写入时复制内存的字节大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|--------|-----------------------------------------------------------------------------------------------------| +| 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 | 无 | 正在写入的线程数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|----------------------------------------------------| +| 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的大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-------------------------------------------------------------------------------------| +| 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 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|------------------------| +| 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 | 无 | | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-----------| +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | #### 指标集合：cluster -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------------------| +| 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命令的统计信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------------------------------------------------------------------------------------------------------------------------| +| 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 index 08788efeaae..1149ed4bdd9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md @@ -5,24 +5,24 @@ sidebar_label: ShenYu网关监控 keywords: [开源监控系统, 开源消息中间件监控, ShenYu网关监控监控] --- -> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 +> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 -## 监控前操作 +## 监控前操作 -您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 +您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 -开启插件, 参考 [官方文档](https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin) +开启插件, 参考 [官方文档](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} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` 2. 在网关的配置yaml文件中编辑如下内容： @@ -39,11 +39,11 @@ shenyu: jvm_enabled: true #开启jvm的监控指标 ``` -最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 +最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -53,79 +53,78 @@ shenyu: | 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | | 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：shenyu_request_total +#### 指标集合：shenyu_request_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-------------------| -| value | 无 | 收集ShenYu网关的所有请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | 收集ShenYu网关的所有请求数量 | #### 指标集合：shenyu_request_throw_created -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------------------| -| value | 无 | 收集ShenYu网关的异常请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | 收集ShenYu网关的异常请求数量 | #### 指标集合：process_cpu_seconds_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| value | 无 | 用户和系统CPU总计所用的秒数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 用户和系统CPU总计所用的秒数 | #### 指标集合：process_open_fds -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------------| -| value | 无 | 打开的文件描述符的数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------| +| value | 无 | 打开的文件描述符的数量 | #### 指标集合：process_max_fds -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------------| -| value | 无 | 打开的文件描述符的最大数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------| +| value | 无 | 打开的文件描述符的最大数量 | #### 指标集合：jvm_info -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-----------| -| runtime | 无 | JVM 版本信息 | -| vendor | 无 | JVM 版本信息 | -| version | 无 | JVM 版本信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| runtime | 无 | JVM 版本信息 | +| vendor | 无 | JVM 版本信息 | +| version | 无 | JVM 版本信息 | #### 指标集合：jvm_memory_bytes_used -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| area | 无 | JVM 内存区域 | -| value | MB | 给定 JVM 内存区域的已用大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| area | 无 | JVM 内存区域 | +| value | MB | 给定 JVM 内存区域的已用大小 | #### 指标集合：jvm_memory_pool_bytes_used -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-----------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已用大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的已用大小 | #### 指标集合：jvm_memory_pool_bytes_committed -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已提交大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的已提交大小 | #### 指标集合：jvm_memory_pool_bytes_max -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------| ----------- | -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的最大大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的最大大小 | #### 指标集合：jvm_threads_state -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-------------| -| state | 无 | 线程状态 | -| value | 无 | 对应线程状态的线程数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------| +| state | 无 | 线程状态 | +| value | 无 | 对应线程状态的线程数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md index 21dcd9a88f3..5755437e80e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md @@ -13,12 +13,11 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit > 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 - **协议使用：SMTP** ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|---------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️无需协议头（例如：https://、http://） | | 监控名称 | 标识此监控的名称。名称需要保持唯一 | @@ -33,9 +32,10 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit #### 指标集：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-------------------| | 响应时间 | 毫秒 | 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 index 086e0a63ac8..a0695849705 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md @@ -19,6 +19,7 @@ keywords: [开源监控工具, 开源 Spring Gateway 监控工具, 监控 Spring spring-boot-starter-actuator ``` + **2. 修改 YML 配置以暴露度量接口:** ```yaml @@ -35,56 +36,55 @@ management: ### 配置参数 -| 参数名称 | 参数描述 | -| ----------- |--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 8080。 | +| 参数名称 | 参数描述 | +|----------|--------------------------------------------------------|-----------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 8080。 | | 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 #### 指标收集: 健康状态 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|--------------------------| -| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|-------------------------| +| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | #### 指标收集: 环境信息 -| 指标名称 | 指标单位 | 指标描述 | -|---------|-------|----------------------------------------------| -| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | -| 端口号 | 无 | 应用程序暴露的端口 | -| 操作系统 | 无 | 运行操作系统 | -| 操作系统架构 | 无 | 运行操作系统的架构 | -| JDK供应商 | 无 | JDK 供应商 | -| JVM版本 | 无 | JVM 版本 | +| 指标名称 | 指标单位 | 指标描述 | +|---------|------|----------------------------------------------| +| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | +| 端口号 | 无 | 应用程序暴露的端口 | +| 操作系统 | 无 | 运行操作系统 | +| 操作系统架构 | 无 | 运行操作系统的架构 | +| JDK供应商 | 无 | JDK 供应商 | +| JVM版本 | 无 | JVM 版本 | #### 指标收集: 线程信息 -| 指标名称 | 指标单位 | 指标描述 | -|-------------|------------|-------------| -| 状态 | 无 | 线程状态 | -| 数量 | 无 | 线程状态对应的线程数量 | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|-------------| +| 状态 | 无 | 线程状态 | +| 数量 | 无 | 线程状态对应的线程数量 | #### 指标收集: 内存使用情况 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|-------------| -| 内存空间 | 无 | 内存空间名称 | -| 内存占用 | MB | 此空间占用的内存大小 | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|------------| +| 内存空间 | 无 | 内存空间名称 | +| 内存占用 | MB | 此空间占用的内存大小 | #### 指标收集: 路由信息 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|----------| -| 路由id | 无 | 路由 ID | -| 匹配规则 | 无 | 路由匹配规则 | -| 资源标识符 | 无 | 服务资源标识符 | -| 优先级 | 无 | 此路由的优先级 | - +| 指标名称 | 指标单位 | 指标描述 | +|-------|------|---------| +| 路由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 index 280c6cb6b06..e66d4237a13 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md @@ -7,7 +7,6 @@ keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控 > 对SpringBoot2.0 actuator 暴露的通用性能指标进行采集监控。 - ## 监控前操作 如果想要通过此监控类型监控 `SpringBoot` 中的信息，则需要您的SpringBoot应用集成并开启SpringBoot Actuator。 @@ -20,6 +19,7 @@ keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控 spring-boot-starter-actuator ``` + **2、修改YML配置暴露指标接口：** ```yaml @@ -30,7 +30,9 @@ management: include: '*' enabled-by-default: on ``` + *注意：如果你的项目里还引入了认证相关的依赖，比如springboot-security,那么SpringBoot Actuator暴露出的接口可能会被拦截，此时需要你手动放开这些接口，以springboot-security为例，需要在SecurityConfig配置类中加入以下代码：* + ```java public class SecurityConfig extends WebSecurityConfigurerAdapter{ @Override @@ -46,48 +48,50 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ } } ``` + ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口，默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | | Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- |--------------------------------| -| status | 无 | 服务健康状态: UP,Down | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-----------------| +| status | 无 | 服务健康状态: UP,Down | #### 指标集合：environment -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------| -------- |----------------------------| -| profile | 无 | 应用运行profile: prod,dev,test | -| port | 无 | 应用暴露端口 | -| os | 无 | 运行所在操作系统 | -| os_arch | 无 | 运行所在操作系统架构 | -| jdk_vendor | 无 | jdk vendor | -| jvm_version | 无 | jvm version | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|----------------------------| +| profile | 无 | 应用运行profile: prod,dev,test | +| port | 无 | 应用暴露端口 | +| os | 无 | 运行所在操作系统 | +| os_arch | 无 | 运行所在操作系统架构 | +| jdk_vendor | 无 | jdk vendor | +| jvm_version | 无 | jvm version | #### 指标集合：threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------- |------|--------------------| -| state | 无 | 线程状态 | -| number | 无 | 此线程状态对应的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------------| +| state | 无 | 线程状态 | +| number | 无 | 此线程状态对应的线程数量 | #### 指标集合：memory_used -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|------------| -| space | 无 | 内存空间名称 | -| mem_used | MB | 此空间占用内存大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-----------| +| space | 无 | 内存空间名称 | +| mem_used | MB | 此空间占用内存大小 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md index 5dc66e27cfc..22a5a50ddd8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md @@ -9,68 +9,68 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1433。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 数据库启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------------------------------------------------| +| 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, 缓存池中每秒写的页数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------|------|-------------------------------------------------------------------------------------| +| 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 | 无 | 已连接的会话数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------| +| user_connection | 无 | 已连接的会话数 | -### 常见问题 +### 常见问题 -1. SSL连接问题修复 +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端返回的任何根证书。 +添加`SqlServer`监控时使用高级设置，自定义JDBC URL，拼接的jdbc url后面加上参数配置，```;encrypt=true;trustServerCertificate=true;```这个参数true表示无条件信任server端返回的任何根证书。 -样例：```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` +样例：```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) +参考文档：[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 index ce0084f7e95..73957e31fb8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md @@ -5,29 +5,30 @@ sidebar_label: SSL证书监控 keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] --- -> 对网站的SSL证书过期时间，响应时间等指标进行监测 +> 对网站的SSL证书过期时间，响应时间等指标进行监测 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，https一般默认为443。 | +| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：certificate +#### 指标集合：certificate + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|----------| +| subject | 无 | 证书名称 | +| expired | 无 | 是否过期 | +| start_time | 无 | 有效期开始时间 | +| start_timestamp | ms毫秒 | 有效期开始时间戳 | +| end_time | 无 | 过期时间 | +| end_timestamp | ms毫秒 | 过期时间戳 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------| -| 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 index c306bebc550..b366ee3c2ac 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md @@ -11,67 +11,65 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | ### Tomcat开启JMX协议步骤 -1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 +1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 -2. vim catalina.sh +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" ``` -参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 +参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md index e5d1be3a140..3ec51e5464a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| 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 index 5dbb2f2c7c6..8efe5262612 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md @@ -5,26 +5,26 @@ sidebar_label: 网站监测 keywords: [开源监控系统, 开源网站监控] --- -> 对网站是否可用，响应时间等指标进行监测 +> 对网站是否可用，响应时间等指标进行监测 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|-------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | +| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：summary +#### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md index 6a1c79b9ede..41447469e61 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md @@ -6,38 +6,39 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 --- > 通过SNMP协议对Windows操作系统的通用性能指标进行采集监控。 -> 注意⚠️ Windows服务器需开启SNMP服务 +> 注意⚠️ 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) +[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 | +| 参数名称 | 参数帮助描述 | +|----------|----------------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Windows SNMP服务对外提供的端口，默认为 161。 | +| SNMP 版本 | SNMP协议版本 V1 V2c V3 | | SNMP 团体字 | SNMP 协议团体名(Community Name)，用于实现SNMP网络管理员访问SNMP管理代理时的身份验证。类似于密码，默认值为 public | -| 超时时间 | 协议连接超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 超时时间 | 协议连接超时时间 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：system -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| name | 无 | 主机名称 | -| descr | 无 | 操作系统描述 | -| uptime | 无 | 系统运行时间 | -| numUsers | 个数 | 当前用户数 | -| services | 个数 | 当前服务数量 | -| processes | 个数 | 当前进程数量 | -| responseTime | ms | 采集响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| 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 index 0783ceaf3fb..14d50c3c90d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, Zookeeper监控监控] > 监控 zookeeper 目前的实现方案使用的是 zookeeper 提供的四字命令 + netcat 来收集指标数据 > 需要用户自己将zookeeper的四字命令加入白名单 -1. 加白名单步骤 +1. 加白名单步骤 > 1.找到我们 zookeeper 的配置文件，一般是 `zoo.cfg` > @@ -25,76 +25,76 @@ keywords: [开源监控系统, Zookeeper监控监控] # 将所有命令添加到白名单中 4lw.commands.whitelist=* ``` + > 3.重启服务 -```shell +```shell zkServer.sh restart ``` -2. netcat 协议 +2. netcat 协议 目前实现方案需要我们部署zookeeper的linux服务器，安装netcat的命令环境 > netcat安装步骤 -```shell -yum install -y nc -``` +> +> ```shell +> yum install -y nc +> ``` 如果终端显示以下信息则说明安装成功 + ```shell Complete! ``` - ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Zookeeper的Linux服务器SSH端口。 | -| 查询超时时间 | 设置Zookeeper连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | Zookeeper所在Linux连接用户名 | -| 密码 | Zookeeper所在Linux连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 服务器编号 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|----------------------------------------| +| 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 | 最小延时 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------------|------|------------| +| 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 index b9767924b38..aa9097c814c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md @@ -16,7 +16,6 @@ slug: / [![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，提供强大的自定义监控和状态页构建能力。 @@ -31,7 +30,7 @@ slug: / - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ---- @@ -48,7 +47,6 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![hertzbeat](/img/home/9.png) - ### 内置监控类型 **官方内置了大量的监控模版类型，方便用户直接在页面添加使用，一款监控类型对应一个YML监控模版** @@ -113,11 +111,11 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 高性能集群 -> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 +> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 -- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 -- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 +- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 +- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 +- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 ![hertzbeat](/img/docs/cluster-arch.png) @@ -134,10 +132,10 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 易用友好 -- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 -- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 -- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 -- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 +- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 +- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 +- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 +- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 - 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 ### 完全开源 @@ -151,8 +149,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![cncf](/img/home/cncf-landscape-left-logo.svg) ------ - +--- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ----- @@ -269,7 +266,6 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/13.png) - ### 告警静默 - 当通过阈值规则判断触发告警后，会进入到告警静默，告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默，此时间段不发送告警消息。 @@ -301,8 +297,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/9.png) - ------ +--- **还有更多强大的功能快去探索呀。Have Fun!** 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 index 480ba184e49..974009005cd 100644 --- 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 @@ -1,8 +1,9 @@ --- id: contact title: 交流联系 -sidebar_label: 交流联系 +sidebar_label: 交流联系 --- + > 如果您在使用过程有任何需要帮助或者想交流建议，可以通过 群 ISSUE 讨论交流。 [GITHUB ISSUES](https://github.com/apache/hertzbeat/issues) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md index b14e75bd68f..d36fb538d92 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md @@ -59,23 +59,31 @@ sidebar_label: 贡献者指南 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 和其他贡献者进行代码审查。 @@ -120,12 +128,14 @@ git pull upstream master ### 模块 - **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务 + > 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。 -- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 +> - **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 > 使用通用协议远程采集获取对端指标数据。 -- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 +> - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 > 采集指标结果数据管理，数据落盘，查询，计算统计。 -- **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 +> - **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 > 告警计算触发，任务状态联动，告警配置，告警通知。 -- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 +> - **[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 index 12069809575..08bd383d97d 100644 --- 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 @@ -1,13 +1,13 @@ --- id: design title: 设计文档 -sidebar_label: 设计文档 +sidebar_label: 设计文档 --- -### HertzBeat架构 +### HertzBeat架构 -![architecture](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/docs/hertzbeat-arch.svg) +![architecture](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/docs/hertzbeat-arch.svg) -### TanCloud架构 +### TanCloud架构 -TanCloud是基于HertzBeat的公网SAAS集群版本，采用多集群，多租户的架构模式。 +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 index f40f3bd9efd..6398980aa50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md @@ -1,10 +1,10 @@ --- id: developer title: 开发者们 -sidebar_label: 开发者们 +sidebar_label: 开发者们 --- -## ✨ HertzBeat的成员们 +## ✨ HertzBeat的成员们 @@ -26,11 +26,11 @@ sidebar_label: 开发者们
-cert +cert ## ✨ HertzBeat的开发者们 -Thanks these wonderful people, welcome to join us: [贡献者指南](contributing) +Thanks these wonderful people, welcome to join us: [贡献者指南](contributing) cert @@ -38,226 +38,223 @@ Thanks these wonderful people, welcome to join us: [贡献者指南](contributin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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
📖
- + + +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 index b934a5c2ca3..9f1d408fc79 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md @@ -1,26 +1,23 @@ --- id: huaweicloud title: HertzBeat & HuaweiCloud -sidebar_label: HertzBeat & HuaweiCloud +sidebar_label: HertzBeat & HuaweiCloud --- -### HertzBeat 与 HuaweiCloud 的开源合作需求Issue +### 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 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 开源活动 HuaweiCloud 华为云将面向开源软件工具链与环境、开源应用构建和开源生态组件构建这三大重点场景，提供技术支持、奖金支持、活动支持，邀请更多的开发者，携手构建开源for HuaweiCloud。 -开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 +开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 感兴趣的开发者可以查看：华为云开源项目仓库 https://gitee.com/HuaweiCloudDeveloper/huaweicloud-cloud-native-plugins-kits 了解更多。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md index 782dbe83c05..ff350e763e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md @@ -1,10 +1,9 @@ --- id: images-deploy title: HertzBeat 华为云镜像部署 -sidebar_label: HertzBeat 华为云镜像部署快速指引 +sidebar_label: HertzBeat 华为云镜像部署快速指引 --- - > 易用友好的开源实时监控告警工具，无需Agent，强大自定义监控能力。 [![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr) @@ -20,20 +19,18 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 ![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) @@ -64,9 +61,9 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 - 和更多的自定义监控。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 -## 镜像部署 +## 镜像部署 -> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 +> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 1. 开通服务器时选用 HertzBeat 镜像 2. 启动服务器 @@ -78,7 +75,6 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](../start/tdengine-init) - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](../start/iotdb-init) - 4. 配置用户配置文件(可选,自定义配置用户密码) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `/opt/hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 @@ -86,10 +82,10 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 5. 部署启动 执行位于安装目录/opt/hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - ``` + + ``` $ ./startup.sh ``` - 6. 开始探索HertzBeat 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 @@ -101,11 +97,14 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 1. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **监控历史图表长时间都一直无数据** + > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md index f87ee49393b..502cfb8429e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md @@ -1,22 +1,22 @@ --- id: resource title: 相关资源 -sidebar_label: 相关资源 +sidebar_label: 相关资源 --- ## HertzBeat PDF介绍文档 下载: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf) -## 图标资源 +## 图标资源 -### HertzBeat LOGO +### HertzBeat LOGO -![logo](/img/hertzbeat-logo.svg) +![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) +下载: [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 +### HertzBeat Brand LOGO ![logo](/img/hertzbeat-brand.svg) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md index 0e6a876da32..fcf927d68ed 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md @@ -1,17 +1,13 @@ --- id: sponsor title: 赞助我们 -sidebar_label: 赞助我们 +sidebar_label: 赞助我们 --- -**HertzBeat对个人或企业完全免费，我们也在全职做这件事情，如果您喜欢这个项目并且愿意提供帮助，请我们喝杯咖啡吧** +**HertzBeat对个人或企业完全免费，我们也在全职做这件事情，如果您喜欢这个项目并且愿意提供帮助，请我们喝杯咖啡吧** planet - 感谢[吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) 赞助服务器采集节点 -感谢[蓝易云(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) 赞助服务器采集节点 - - - +感谢[蓝易云(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) 赞助服务器采集节点 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md index 8436a317158..328447b586f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md @@ -1,13 +1,13 @@ --- id: account-modify title: 配置修改账户密码 -sidebar_label: 配置修改账户密码 +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) +配置文件内容参考 项目仓库[/script/sureness.yml](https://github.com/apache/hertzbeat/blob/master/script/sureness.yml) ```yaml @@ -125,4 +125,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** +**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md index 7dde7ec14e9..01380784169 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md @@ -1,23 +1,25 @@ --- id: custom-config title: 常见参数配置 -sidebar_label: 常见参数配置 +sidebar_label: 常见参数配置 --- 这里描述了如果配置短信服务器，内置可用性告警触发次数等。 -**`hertzbeat`的配置文件`application.yml`** +**`hertzbeat`的配置文件`application.yml`** -### 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 - 安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 +### 配置HertzBeat的配置文件 + +修改位于 `hertzbeat/config/application.yml` 的配置文件 +注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 +安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 1. 配置短信发送服务器 -> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 +> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 + +在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) -在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) ```yaml common: sms: @@ -28,15 +30,17 @@ common: sign-name: 赫兹跳动 template-id: 1343434 ``` + 1.1 腾讯云短信创建签名（sign-name） ![image](https://github.com/apache/hertzbeat/assets/40455946/3a4c287d-b23d-4398-8562-4894296af485) 1.2 腾讯云短信创建正文模板（template-id） + ``` 监控:{1}，告警级别:{2}。内容:{3} ``` -![image](https://github.com/apache/hertzbeat/assets/40455946/face71a6-46d5-452c-bed3-59d2a975afeb) +![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) @@ -44,8 +48,7 @@ common: 1.4 腾讯云访问管理（secret-id、secret-key） ![image](https://github.com/apache/hertzbeat/assets/40455946/36f056f0-94e7-43db-8f07-82893c98024e) - -2. 配置告警自定义参数 +2. 配置告警自定义参数 ```yaml alerter: @@ -53,11 +56,12 @@ alerter: console-url: https://console.tancloud.io ``` -3. 使用外置redis代替内存存储实时指标数据 +3. 使用外置redis代替内存存储实时指标数据 -> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 +> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 + +注意⚠️ `memory.enabled: false, redis.enabled: true` -注意⚠️ `memory.enabled: false, redis.enabled: true` ```yaml warehouse: store: @@ -70,3 +74,4 @@ warehouse: port: 6379 password: 123456 ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md index c0b963c69e7..3eb90180a89 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md @@ -1,14 +1,14 @@ --- id: docker-deploy title: 通过 Docker 方式安装 HertzBeat -sidebar_label: Docker方式部署 +sidebar_label: Docker方式部署 --- -> 推荐使用Docker部署HertzBeat +> 推荐使用Docker部署HertzBeat 1. 下载安装Docker环境 Docker 工具自身的下载请参考以下资料： - [Docker官网文档](https://docs.docker.com/get-docker/) + [Docker官网文档](https://docs.docker.com/get-docker/) [菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html) 安装完毕后终端查看Docker版本是否正常输出。 @@ -16,7 +16,6 @@ sidebar_label: Docker方式部署 $ docker -v Docker version 20.10.12, build e91ed57 ``` - 2. 拉取HertzBeat Docker镜像 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) 或者使用 [quay.io 镜像仓库](https://quay.io/repository/apache/hertzbeat) @@ -25,12 +24,13 @@ sidebar_label: Docker方式部署 $ 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 @@ -46,25 +46,22 @@ sidebar_label: Docker方式部署 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) + 下载源 [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) - + - **推荐**若需使用外置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容器 + 具体修改步骤参考 [配置修改账户密码](account-modify) +6. 启动HertzBeat Docker容器 -```shell +```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=zh_CN.UTF-8 \ -e TZ=Asia/Shanghai \ @@ -76,34 +73,31 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ --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`代替。** + 这条命令启动一个运行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 - 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 8. 部署采集器集群(可选) -```shell +```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ @@ -112,52 +106,57 @@ $ docker run -d \ --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`代替。** +这条命令启动一个运行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` 查看概览页面即可看到注册上来的新采集器 +8. 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 -**HAVE FUN** +**HAVE FUN** -### Docker部署常见问题 +### Docker部署常见问题 **最多的问题就是网络问题，请先提前排查** 1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** -此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + > 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` +> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` 2. **按照流程部署，访问 http://ip:1157/ 无界面** -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 -3. **日志报错TDengine连接或插入SQL失败** +3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter + +4. **监控历史图表长时间都一直无数据** -4. **监控历史图表长时间都一直无数据** > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB或Tdengine IP账户密码等配置是否正确 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB或Tdengine IP账户密码等配置是否正确 5. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - -> 安装初始化此数据库参考 [TDengine安装初始化](tdengine-init) 或 [IoTDB安装初始化](iotdb-init) +> 安装初始化此数据库参考 [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 index 4c98f15722d..81d950a392c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md @@ -1,7 +1,7 @@ --- id: greptime-init title: 依赖时序数据库服务GreptimeDB安装初始化 -sidebar_label: 使用GreptimeDB存储指标数据(可选) +sidebar_label: 使用GreptimeDB存储指标数据(可选) --- HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) @@ -10,18 +10,21 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 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 -### 通过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 +> 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 \ @@ -32,16 +35,16 @@ $ docker run -p 4000-4004:4000-4004 \ --rpc-addr 0.0.0.0:4001 ``` - `-v /opt/greptimedb:/tmp/greptimedb` 为greptimedb数据目录本地持久化挂载，需将`/opt/greptimedb`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/greptimedb:/tmp/greptimedb` 为greptimedb数据目录本地持久化挂载，需将`/opt/greptimedb`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -56,8 +59,9 @@ warehouse: 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 index f98fb837438..9f19a733b2e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md @@ -1,35 +1,38 @@ --- id: influxdb-init title: 依赖时序数据库服务InfluxDB安装初始化 -sidebar_label: 使用InfluxDB存储指标数据(可选) +sidebar_label: 使用InfluxDB存储指标数据(可选) --- HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) 我们推荐使用并长期支持VictoriaMetrics -InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 +InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** ### 1. 直接使用华为云服务 GaussDB For Influx -> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) - +> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) +> > 获取云数据库对外暴露连接地址，账户密码即可 ⚠️注意云数据库默认开启了SSL，云数据库地址应使用 `https:` -### 2. 通过Docker方式安装InfluxDB +### 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 +> 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 \ @@ -37,17 +40,16 @@ $ docker run -p 8086:8086 \ influxdb:1.8 ``` - `-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 - -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -66,10 +68,9 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 -1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 +1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md index bc37b31491a..c26e8feb7b0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md @@ -1,7 +1,7 @@ --- id: iotdb-init title: 依赖时序数据库服务IoTDB安装初始化 -sidebar_label: 使用IoTDB存储指标数据(可选) +sidebar_label: 使用IoTDB存储指标数据(可选) --- HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) @@ -10,21 +10,23 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统，我们使用其存储分析采集到的监控指标历史数据。支持V0.12 - V0.13版本，推荐使用V0.13.*版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有IoTDB环境，可直接跳到YML配置那一步。 +### 通过Docker方式安装IoTDB -### 通过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 +> 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 \ @@ -33,16 +35,16 @@ $ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ apache/iotdb:0.13.3-node ``` - `-v /opt/iotdb/data:/iotdb/data` 为IoTDB数据目录本地持久化挂载，需将`/iotdb/data`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/iotdb/data:/iotdb/data` 为IoTDB数据目录本地持久化挂载，需将`/iotdb/data`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 -3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接 +3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.iot-db`数据源参数，HOST账户密码等，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.iot-db`数据源参数，HOST账户密码等，并启用`enabled`为`true`** ```yaml warehouse: @@ -67,16 +69,20 @@ warehouse: 4. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 -3. 安装配置了IotDB数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] +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 index 8db668fb634..fdf25643f1d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md @@ -1,23 +1,27 @@ --- id: mysql-change title: 关系型数据库使用 Mysql 替换依赖的 H2 存储系统元数据 -sidebar_label: 元数据使用Mysql存储(可选) +sidebar_label: 元数据使用Mysql存储(可选) --- -MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 + +MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 -> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 +> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 + +### 通过Docker方式安装MYSQL -### 通过Docker方式安装MYSQL 1. 下载安装Docker环境 Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 - 安装完毕后终端查看Docker版本是否正常输出。 + 安装完毕后终端查看Docker版本是否正常输出。 + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. Docker安装MYSQl +2. Docker安装MYSQl + ``` $ docker run -d --name mysql \ -p 3306:3306 \ @@ -26,26 +30,29 @@ MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默 --restart=always \ mysql:5.7 ``` + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 -### 数据库创建 +### 数据库创建 + 1. 进入MYSQL或使用客户端连接MYSQL服务 - `mysql -uroot -p123456` + `mysql -uroot -p123456` 2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 查看hertzbeat数据库是否创建成功 `show databases;` -### 修改hertzbeat的配置文件application.yml切换数据源 +### 修改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) - -需修改部分原参数: + ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + +需修改部分原参数: + ```yaml spring: datasource: @@ -54,7 +61,9 @@ spring: password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL ``` -具体替换参数如下,需根据mysql环境配置账户密码IP: + +具体替换参数如下,需根据mysql环境配置账户密码IP: + ```yaml spring: datasource: @@ -66,10 +75,9 @@ spring: 2. 通过docker启动时，需要修改host为宿主机的外网Ip，包括mysql连接字符串和redis。 +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** - -### 常见问题 +### 常见问题 1. 缺少hibernate的mysql方言，导致启动异常 Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set @@ -85,3 +93,4 @@ spring: hibernate: dialect: org.hibernate.dialect.MySQL5InnoDBDialect ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md index 4965e19bbfd..bbb44f546b3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md @@ -1,22 +1,24 @@ --- id: package-deploy title: 通过安装包安装 HertzBeat -sidebar_label: 安装包方式部署 +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 - ``` + 解压安装包到主机 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)） @@ -27,20 +29,20 @@ sidebar_label: 安装包方式部署 3. 配置用户配置文件(可选,自定义配置用户密码) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 - 具体参考 [配置修改账户密码](account-modify) + 具体参考 [配置修改账户密码](account-modify) 4. 部署启动 - 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - ``` + 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat + + ``` $ ./startup.sh ``` - 5. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 - + 浏览器访问 http://ip:1157/ 即刻开始探索使用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: @@ -57,7 +59,6 @@ sidebar_label: 安装包方式部署 **HAVE FUN** - ### 安装包部署常见问题 **最多的问题就是网络环境问题，请先提前排查** @@ -68,25 +69,30 @@ sidebar_label: 安装包方式部署 要求：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) - ``` +``` +$ 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. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter 4. **监控历史图表长时间都一直无数据** + > 一：时序数据库是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md index b09f969e4da..6f2d7cdf7bc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md @@ -3,42 +3,43 @@ id: postgresql-change title: 关系型数据库使用 PostgreSQL 替换依赖的 H2 存储系统元数据 sidebar_label: 元数据使用PostgreSQL存储(可选) --- -PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBMS）。HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用PostgreSQL存储监控信息，告警信息，配置信息等结构化关系数据。 -注意⚠️ 使用外置PostgreSQL数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 +PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBMS）。HertzBeat除了支持使用默认内置的H2数据库外，还可以切换为使用PostgreSQL存储监控信息，告警信息，配置信息等结构化关系数据。 -> 如果您已有PostgreSQL环境，可直接跳到数据库创建那一步。 +注意⚠️ 使用外置PostgreSQL数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 +> 如果您已有PostgreSQL环境，可直接跳到数据库创建那一步。 -### 通过Docker方式安装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 服务 -1. 进入 PostgreSQL 或使用客户端连接 PostgreSQL 服务 ``` su - postgres psql ``` - 2. 创建名称为hertzbeat的数据库 `CREATE DATABASE hertzbeat;` - 3. 查看hertzbeat数据库是否创建成功 `\l` @@ -58,7 +59,9 @@ spring: password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL ``` + 具体替换参数如下,需根据 PostgreSQL 环境配置账户密码IP: + ```yaml spring: config: @@ -81,4 +84,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md index ac8d65db395..f520ba5f0a4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md @@ -1,18 +1,18 @@ --- id: quickstart title: 快速开始 -sidebar_label: 快速开始 +sidebar_label: 快速开始 --- ### 🐕 开始使用 - 如果您是想将HertzBeat部署到本地搭建监控系统，请参考下面的部署文档进行操作。 +### 🍞 HertzBeat安装 -### 🍞 HertzBeat安装 > HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持X86/ARM64。 -#### 方式一：Docker方式快速安装 +#### 方式一：Docker方式快速安装 1. `docker` 环境仅需一条命令即可开始 @@ -29,14 +29,15 @@ sidebar_label: 快速开始 ``` 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) +更多配置详细步骤参考 [通过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`(可选) @@ -45,6 +46,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 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: @@ -59,9 +61,9 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 -更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) +更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) -#### 方式三：本地代码启动 +#### 方式三：本地代码启动 1. 此为前后端分离项目，本地代码调试需要分别启动后端工程`manager`和前端工程`web-app` 2. 后端：需要`maven3+`, `java11`和`lombok`环境，修改`YML`配置信息并启动`manager`服务 @@ -74,7 +76,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 通过 [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) +详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) ##### 方式五：Kubernetes Helm Charts 部署 hertzbeat+collector+mysql+iotdb @@ -121,4 +123,4 @@ $ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ apache/iotdb:0.13.3-node ``` -详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) +详细步骤参考 [使用时序数据库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 index 0a55beb17a7..83afd21fc92 100644 --- 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 @@ -1,7 +1,7 @@ --- id: rainbond-deploy title: 使用 Rainbond 部署 HertzBeat -sidebar_label: Rainbond方式部署 +sidebar_label: Rainbond方式部署 --- 如果你不熟悉 Kubernetes，想在 Kubernetes 中安装 HertzBeat，可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台，可以很简单的将你的应用部署到 Kubernetes中。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md index 9731621b4e9..fbcbab39578 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md @@ -4,7 +4,6 @@ title: SSL证书过期监控使用案例 sidebar_label: 使用案例 --- - 现在大部分网站都默认支持 HTTPS，我们申请的证书一般是3个月或者1年，很容易随着时间的流逝SSL证书过期了我们却没有第一时间发现，或者在过期之前没有及时更新证书。 这篇文章介绍如果使用 hertzbeat 监控系统来检测我们网站的SSL证书有效期，当证书过期时或证书快过期前几天，给我们发告警消息。 @@ -34,10 +33,8 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书 - ![](/img/docs/start/ssl_1.png) - 2. 配置监控网站 > 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md index 1b70a487d41..c09e1daf15e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md @@ -1,30 +1,32 @@ --- id: tdengine-init title: 依赖时序数据库服务TDengine安装初始化 -sidebar_label: 使用TDengine存储指标数据(可选) +sidebar_label: 使用TDengine存储指标数据(可选) --- HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) 我们推荐使用并长期支持VictoriaMetrics -TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 +TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 +### 通过Docker方式安装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 +> 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 \ @@ -33,23 +35,23 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ tdengine/tdengine:3.0.4.0 ``` - `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 - `-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 +`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 +使用```$ docker ps```查看数据库是否启动成功 + +### 创建数据库实例 -### 创建数据库实例 +> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) -> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) +1. 进入数据库Docker容器 -1. 进入数据库Docker容器 ``` $ docker exec -it tdengine /bin/bash ``` - 2. 修改账户密码 > 建议您修改密码。TDengine默认的账户密码是 root/taosdata - > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: + > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: ``` root@tdengine-server:~/TDengine-server# taos @@ -57,6 +59,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. taos> ``` + > 在 TDengine CLI 中使用 alter user 命令可以修改用户密码，缺省密码为 taosdata 3. 创建名称为hertzbeat的数据库 @@ -76,24 +79,23 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ taos> show databases; taos> use hertzbeat; ``` - 5. 退出TDengine CLI ``` 输入 q 或 quit 或 exit 回车 ``` -**注意⚠️若是安装包安装的TDengine** +**注意⚠️若是安装包安装的TDengine** > 除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -111,19 +113,24 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 -2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] +2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 -3. 监控详情历史图片不展示或无数据，已经配置了TDengine +3. 监控详情历史图片不展示或无数据，已经配置了TDengine + > 请确认是否安装的TDengine版本为3.0以上，版本2.x不支持兼容 4. 安装配置了TDengine数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 请检查配置参数是否正确 > td-engine enable是否设置为true > 注意⚠️若hertzbeat和TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP -> 可根据logs目录下启动日志排查 +> 可根据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 index f70019c1575..ed85c460e76 100644 --- 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 @@ -1,7 +1,7 @@ --- id: upgrade title: HertzBeat 新版本更新指引 -sidebar_label: 版本更新指引 +sidebar_label: 版本更新指引 --- **HertzBeat 的发布版本列表** @@ -15,8 +15,6 @@ HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据 **升级前您需要保存备份好数据库的数据文件和监控模版文件** - - ### Docker部署方式的升级 1. 若使用了自定义监控模版 @@ -24,32 +22,26 @@ HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据 - `docker cp hertzbeat:/opt/hertzbeat/define ./define` - 然后在后续升级启动 docker 容器的时候需要挂载上这个 define 目录，`-v $(pwd)/define:/opt/hertzbeat/define` - `-v $(pwd)/define:/opt/hertzbeat/define` - -2. 若使用内置默认 H2 数据库 +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/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** +**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 index 8c9ae087058..d1608031078 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md @@ -1,7 +1,7 @@ --- id: victoria-metrics-init title: 依赖时序数据库服务VictoriaMetrics安装初始化 -sidebar_label: 使用VictoriaMetrics存储指标数据(推荐) +sidebar_label: 使用VictoriaMetrics存储指标数据(推荐) --- HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) @@ -10,21 +10,23 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 +### 通过Docker方式安装VictoriaMetrics -### 通过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 +> 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 \ @@ -33,16 +35,16 @@ $ docker run -d -p 8428:8428 \ victoriametrics/victoria-metrics:v1.95.1 ``` - `-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 - 使用```$ docker ps```查看数据库是否启动成功 +`-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 +使用```$ docker ps```查看数据库是否启动成功 -3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 +3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** ```yaml warehouse: @@ -60,8 +62,9 @@ warehouse: 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 index c3d507a11f8..16205107eaa 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md @@ -4,27 +4,27 @@ title: 监控模版中心 sidebar_label: 监控模版 --- -> Hertzbeat 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 - +> Hertzbeat 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ -这是它的架构原理: +这是它的架构原理: ![hertzBeat](/img/docs/hertzbeat-arch.png) -**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版，用户可以导入这些模版到hertzbeat系统中，使其支持对应类型的监控，非常方便！** +**我们将所有监控采集类型(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)
+ 👉 [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)
@@ -32,7 +32,7 @@ sidebar_label: 监控模版  👉 [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)
@@ -49,7 +49,7 @@ sidebar_label: 监控模版  👉 [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)
@@ -64,7 +64,6 @@ sidebar_label: 监控模版  👉 [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)
@@ -78,13 +77,12 @@ sidebar_label: 监控模版  👉 [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)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md index 31fe0ac98f7..79bed896359 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md @@ -3,14 +3,17 @@ id: extend-http-default title: HTTP协议系统默认解析方式 sidebar_label: 系统默认解析方式 --- -> HTTP接口调用获取响应数据后，用 Apache HertzBeat (incubating) 默认的解析方式去解析响应数据。 -**此需接口响应数据结构符合HertzBeat指定的数据结构规则** +> HTTP接口调用获取响应数据后，用 Apache HertzBeat (incubating) 默认的解析方式去解析响应数据。 -### HertzBeat数据格式规范 -注意⚠️ 响应数据为JSON +**此需接口响应数据结构符合HertzBeat指定的数据结构规则** + +### HertzBeat数据格式规范 + +注意⚠️ 响应数据为JSON 单层格式：key-value + ```json { "metricName1": "metricValue", @@ -19,7 +22,9 @@ sidebar_label: 系统默认解析方式 "metricName4": "metricValue" } ``` + 多层格式：数组里面套key-value + ```json [ { @@ -36,9 +41,11 @@ sidebar_label: 系统默认解析方式 } ] ``` + 样例： 查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 -若只有一台虚拟机，其单层格式为: +若只有一台虚拟机，其单层格式为: + ```json { "hostname": "linux-1", @@ -48,7 +55,9 @@ sidebar_label: 系统默认解析方式 "runningTime": 100 } ``` -若有多台虚拟机，其多层格式为: + +若有多台虚拟机，其多层格式为: + ```json [ { @@ -75,7 +84,7 @@ sidebar_label: 系统默认解析方式 ] ``` -**对应的监控模版YML可以配置为如下** +**对应的监控模版YML可以配置为如下** ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -148,3 +157,4 @@ metrics: # 这里使用HertzBeat默认解析 parseType: default ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md index 160adf031c9..03602131897 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md @@ -1,19 +1,17 @@ --- id: extend-http-example-hertzbeat title: 教程一:适配一款基于HTTP协议的监控类型 -sidebar_label: 教程一:适配一款HTTP协议监控 +sidebar_label: 教程一:适配一款HTTP协议监控 --- -通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 监控系统下新增适配一款基于http协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 监控系统下新增适配一款基于http协议的监控类型。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 ### HTTP协议解析通用响应结构体，获取指标数据 > 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - ``` { "code": 200, @@ -22,6 +20,7 @@ sidebar_label: 教程一:适配一款HTTP协议监控 } ``` + 如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API `http://localhost:1157/api/summary`, 其响应数据为: @@ -58,7 +57,6 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - ### 新增自定义监控模版YML **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -188,32 +186,24 @@ metrics: **新增完毕，现在我们重启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!!! - ---- #### 完！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md index 94f49c01f61..bebcc99244a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md @@ -6,15 +6,15 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 通过此教程我们一步一步描述如何在教程一的基础上改造，新增一个监控指标，先调用认证接口获取TOKEN后，使用TOKEN作为参数供后面的监控指标采集认证使用。 -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 -### 请求流程 +### 请求流程 -【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 +【**认证信息监控指标(优先级最高)**】【**HTTP接口携带账户密码调用**】->【**响应数据解析**】->【**解析签发TOKEN-accessToken作为指标**】->【**将accessToken作为变量参数赋值给其他采集监控指标**】 > 这里我们依然用教程一的hertzbeat监控举例！hertzbeat后台接口不仅仅支持教程一使用的basic直接账户密码认证，也支持token认证。 -**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: +**我们需要`POST`调用登录接口`/api/account/auth/form`获取`accessToken`,请求body(json格式)如下**: ```json { @@ -22,7 +22,8 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 "identifier": "admin" } ``` -**响应结构数据如下**: + +**响应结构数据如下**: ```json { @@ -99,9 +100,9 @@ metrics: ...... ``` -### 定义监控指标`auth`登录请求获取`token` +### 定义监控指标`auth`登录请求获取`token` -1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. +1. 在`app-hertzbeat_token.yml`新增一个监控指标定义 `auth`, 设置采集优先级为最高0，采集指标 `token`. ```yaml @@ -206,16 +207,13 @@ metrics: ![](/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`作为变量参数给后面的监控指标采集使用 +### 将`token`作为变量参数给后面的监控指标采集使用 **在`app-hertzbeat_token.yml`新增一个监控指标定义 `summary` 同教程一中的`summary`相同, 设置采集优先级为1** **设置此监控指标的HTTP协议配置中认证方式为 `Bearer Token` 将上一个监控指标`auth`采集的指标`token`作为参数给其赋值，使用`^o^`作为内部替换符标识，即`^o^token^o^`。如下:** @@ -231,7 +229,7 @@ metrics: bearerTokenToken: ^o^token^o^ ``` -**最终`app-hertzbeat_token.yml`定义如下:** +**最终`app-hertzbeat_token.yml`定义如下:** ```yaml @@ -368,9 +366,9 @@ metrics: ``` -**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** +**配置完成后，再次重启 `hertzbeat` 系统，查看监控详情页面** -![](/img/docs/advanced/extend-http-example-8.png) +![](/img/docs/advanced/extend-http-example-8.png) ![](/img/docs/advanced/extend-http-example-9.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md index ae29f265574..befd1db351f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md @@ -3,16 +3,18 @@ id: extend-http-jsonpath title: HTTP协议JsonPath解析方式 sidebar_label: JsonPath解析方式 --- + > HTTP接口调用获取响应数据后，用JsonPath脚本解析的解析方式去解析响应数据。 注意⚠️ 响应数据为JSON格式 -**使用JsonPath脚本将响应数据解析成符合 Apache HertzBeat (incubating) 指定的数据结构规则的数据** +**使用JsonPath脚本将响应数据解析成符合 Apache HertzBeat (incubating) 指定的数据结构规则的数据** + +#### JsonPath操作符 -#### JsonPath操作符 -[JSONPath在线验证](https://www.jsonpath.cn) +[JSONPath在线验证](https://www.jsonpath.cn) -| JSONPATH | 帮助描述 | +| JSONPATH | 帮助描述 | |------------------|-----------------------------------| | $ | 根对象或元素 | | @ | 当前对象或元素 | @@ -25,8 +27,10 @@ sidebar_label: JsonPath解析方式 | ?() | 过滤器（脚本）表达式. | | () | 脚本表达式. | -#### HertzBeat数据格式规范 +#### HertzBeat数据格式规范 + 单层格式：key-value + ```json { "metricName1": "metricValue", @@ -35,7 +39,9 @@ sidebar_label: JsonPath解析方式 "metricName4": "metricValue" } ``` + 多层格式：数组里面套key-value + ```json [ { @@ -53,10 +59,11 @@ sidebar_label: JsonPath解析方式 ] ``` -#### 样例 +#### 样例 查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 -接口返回的原始数据如下： +接口返回的原始数据如下： + ```json { "firstName": "John", @@ -80,7 +87,8 @@ sidebar_label: JsonPath解析方式 } ``` -我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： +我们使用JsonPath脚本解析，对应的脚本为: `$.number[*]` ，解析后的数据结构如下： + ```json [ { @@ -93,9 +101,10 @@ sidebar_label: JsonPath解析方式 } ] ``` -此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 -**对应的监控模版YML可以配置为如下** +此数据结构符合HertzBeat的数据格式规范，成功提取指标`type,num`值。 + +**对应的监控模版YML可以配置为如下** ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -166,3 +175,4 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md index 21b8015da77..1a4a132c073 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md @@ -1,21 +1,22 @@ --- id: extend-http title: HTTP协议自定义监控 -sidebar_label: HTTP协议自定义监控 +sidebar_label: HTTP协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 -### HTTP协议采集流程 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用HTTP协议自定义指标监控。 + +### HTTP协议采集流程 + 【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 -HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 +HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 **系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) -**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) - +**JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -23,15 +24,14 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ------- -下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 +下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 -### 监控模版YML +### 监控模版YML > 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 -样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 - +样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -204,3 +204,4 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md index 6ff4b9bbed1..bb946d8ce1c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md @@ -1,29 +1,34 @@ --- id: extend-jdbc title: JDBC协议自定义监控 -sidebar_label: JDBC协议自定义监控 +sidebar_label: JDBC协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 -> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 -### JDBC协议采集流程 -【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 +> JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标 + +### JDBC协议采集流程 + +【**系统直连MYSQL**】->【**运行SQL查询语句**】->【**响应数据解析:oneRow, multiRow, columns**】->【**指标数据提取**】 由流程可见，我们自定义一个JDBC协议的监控类型，需要配置JDBC请求参数，配置获取哪些指标，配置查询SQL语句。 -### 数据解析方式 +### 数据解析方式 + SQL查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有三种：oneRow, multiRow, columns -#### **oneRow** -> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 +#### **oneRow** + +> 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book limit 1; -这里指标字段就能和响应数据一一映射为一行采集数据。 +这里指标字段就能和响应数据一一映射为一行采集数据。 #### **multiRow** -> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 + +> 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 例如： 查询的指标字段为：one tow three four @@ -31,33 +36,34 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 这里指标字段就能和响应数据一一映射为多行采集数据。 #### **columns** -> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 + +> 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 例如： 查询字段：one tow three four 查询SQL：select key, value from book; -SQL响应数据： +SQL响应数据： -| key | value | -|----------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +| key | value | +|-------|-------| +| one | 243 | +| two | 435 | +| three | 332 | +| four | 643 | -这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 +这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) - ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 -### 监控模版YML +下面详细介绍下文件的配置用法，请注意看使用注释。 + +### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 @@ -237,3 +243,4 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md index cca1bcfb726..71bb06ba2b2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md @@ -1,38 +1,38 @@ --- id: extend-jmx title: JMX协议自定义监控 -sidebar_label: JMX协议自定义监控 +sidebar_label: JMX协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 -> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 +> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 + +### JMX协议采集流程 -### JMX协议采集流程 -【**对端JAVA应用暴露JMX服务**】->【**HertzBeat直连对端JMX服务**】->【**获取配置的 Mbean Object 数据**】->【**指标数据提取**】 +【**对端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协议采集指标数据。 - +样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -236,3 +236,4 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md index b5685eb3b16..34514b3f2bb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md @@ -20,11 +20,11 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 > `filterName`: 过滤属性名称（可选） > `filterValue`: 过滤属性值（可选） -例如： +例如： - online_meta_count#SHOW HOSTS META#Status#ONLINE - 对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 +对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 - online_meta_count#SHOW HOSTS META## - 统计 `SHOW HOSTS META` 返回的行数 +统计 `SHOW HOSTS META` 返回的行数 #### **oneRow** @@ -72,6 +72,7 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 ![](/img/docs/advanced/extend-point-1.png) ------- + 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML @@ -169,3 +170,4 @@ metrics: - match (v:tag2) return "tag2" as name ,count(v) as cnt timeout: ^_^timeout^_^ ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md index c951f1bc190..a59d9b1898a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md @@ -1,12 +1,13 @@ --- id: extend-point title: 自定义监控 -sidebar_label: 自定义监控 +sidebar_label: 自定义监控 --- + > HertzBeat拥有自定义监控能力，您只需配置监控模版YML就能适配一款自定义的监控类型。 -> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 +> 目前自定义监控支持[HTTP协议](extend-http)，[JDBC协议](extend-jdbc)，[SSH协议](extend-ssh)，[JMX协议](extend-jmx)，[SNMP协议](extend-snmp)，后续会支持更多通用协议。 -### 自定义流程 +### 自定义流程 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** @@ -14,13 +15,13 @@ sidebar_label: 自定义监控 ------- -### 监控模版YML +### 监控模版YML **HertzBeat的设计是一个监控模版对应一个监控类型，所有监控类型都是由监控模版来定义的**。 -> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 +> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 -下面使用样例详细介绍下这监控模版YML的配置用法。 +下面使用样例详细介绍下这监控模版YML的配置用法。 样例：自定义一个 `app` 名称为 `example2` 的自定义监控类型，其使用HTTP协议采集指标数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md index 3ff65d60a17..387d67c5987 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md @@ -1,38 +1,38 @@ --- id: extend-snmp title: SNMP协议自定义监控 -sidebar_label: SNMP协议自定义监控 +sidebar_label: SNMP协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 -> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 +> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 + +### SNMP协议采集流程 -### SNMP协议采集流程 -【**对端开启SNMP服务**】->【**HertzBeat直连对端SNMP服务**】->【**根据配置抓取对端OID指标信息**】->【**指标数据提取**】 +【**对端开启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 协议采集指标数据。 - +样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 ```yaml # The monitoring type category：service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring @@ -207,3 +207,4 @@ metrics: processes: 1.3.6.1.2.1.25.1.6.0 location: 1.3.6.1.2.1.1.6.0 ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md index 8284726e661..0f643f153f8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md @@ -1,21 +1,25 @@ --- id: extend-ssh title: SSH协议自定义监控 -sidebar_label: SSH协议自定义监控 +sidebar_label: SSH协议自定义监控 --- + > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 -> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 +> SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 + +### SSH协议采集流程 -### SSH协议采集流程 -【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 +【**系统直连Linux**】->【**运行SHELL命令脚本语句**】->【**响应数据解析:oneRow, multiRow**】->【**指标数据提取**】 由流程可见，我们自定义一个SSH协议的监控类型，需要配置SSH请求参数，配置获取哪些指标，配置查询脚本语句。 -### 数据解析方式 +### 数据解析方式 + SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获取对应的指标数据，目前映射解析方式有两种：oneRow, multiRow，能满足绝大部分指标需求。 -#### **oneRow** -> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 +#### **oneRow** + +> 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 例如： 需要查询Linux的指标 hostname-主机名称，uptime-启动时间 @@ -23,31 +27,37 @@ SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获 启动时间原始查询命令：`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` +uptime值为 `14:00:15 up 72 days` -这里指标字段就能和响应数据一一映射为一行采集数据。 +这里指标字段就能和响应数据一一映射为一行采集数据。 #### **multiRow** -> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 + +> 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 例如： 查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 -内存指标原始查询命令为：`free -m`, 控制台响应： +内存指标原始查询命令为：`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 @@ -55,22 +65,22 @@ total used free buff_cache available 这里指标字段就能和响应数据一一映射为采集数据。 -### 自定义步骤 +### 自定义步骤 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** ![](/img/docs/advanced/extend-point-1.png) ------- -下面详细介绍下文件的配置用法，请注意看使用注释。 + +下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 -样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 - +样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 ```yaml # 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -206,3 +216,4 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md index c536fabf6c4..369210ee6be 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md @@ -4,16 +4,14 @@ title: 自定义适配一款基于HTTP协议的新监控类型 sidebar_label: 教程案例 --- -通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 系统下自定义新增适配一款基于 http 协议的监控类型。 - -阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 +通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 系统下自定义新增适配一款基于 http 协议的监控类型。 +阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型，指标，协议等。 ### HTTP协议解析通用响应结构体，获取指标数据 > 很多场景我们需要对提供的 HTTP API 接口进行监控，获取接口返回的指标值。这篇文章我们通过http自定义协议来解析我们常见的http接口响应结构，获取返回体中的字段作为指标数据。 - ``` { "code": 200, @@ -22,6 +20,7 @@ sidebar_label: 教程案例 } ``` + 如上，通常我们的后台API接口会设计这这样一个通用返回。hertzbeat系统的后台也是如此，我们今天就用hertzbeat的 API 做样例，新增适配一款新的监控类型 **hertzbeat**，监控采集它的系统摘要统计API `http://localhost:1157/api/summary`, 其响应数据为: @@ -58,12 +57,11 @@ sidebar_label: 教程案例 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** - ### 新增配置监控模版YML **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 +定义我们在页面上需要输入哪些参数，一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等，我们直接复用 `api`监控模版 里面的参数定义内容，删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 定义采集类型是啥，需要用哪种协议采集方式，采集的指标是啥，协议的配置参数等。我们直接复用 `api`监控模版 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可，如下：注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 @@ -221,32 +219,24 @@ metrics: **点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`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!!! - ---- #### 完！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md index c91cdca7171..c30a850a3c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md @@ -5,23 +5,22 @@ sidebar_position: 2 --- - ## 成为 Apache HertzBeat™ 的 Committer 任何支持社区并在 CoPDoC 领域中工作的人都可以成为 Apache HertzBeat 的 Committer。CoPDoC 是 ASF 的缩写，用来描述我们如何不仅仅通过代码来认识到您的贡献。 @@ -58,3 +57,4 @@ Committer 的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - 对于拉取请求审查保持积极、有礼貌与尊重。 - 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 - 通过撰写文章或举办活动来推广项目。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md index e64661b7595..39cf1da9123 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md @@ -5,20 +5,20 @@ sidebar_position: 3 --- ## 成为 Apache HertzBeat™ 的 PMC 成员 @@ -45,6 +45,7 @@ PMC 成员的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - +3 个月的高度活动和参与。 ### 贡献的质量 + - 对项目有深入的理解。 - 经过充分测试、良好设计、遵循 Apache HertzBeat 的编码标准，及简单的修复补丁。 - 井井有条的面向用户的详细文档。 @@ -56,3 +57,4 @@ PMC 成员的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - 对于拉取请求审查保持积极、有礼貌与尊重。 - 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 - 通过撰写文章或举办活动来推广项目。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md index a9a6f54d474..1cad8c3add1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md @@ -5,41 +5,38 @@ sidebar_position: 3 --- - ## 1 拉取请求与变更规则 1. `ISSUE`/`PR`(拉取请求) 的引导和命名 - - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) + - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) - - 标题命名格式(英文，小写) - `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + - 标题命名格式(英文，小写) + `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` 2. 添加描述信息 - - 新建 `PR` 时请仔细描述此贡献，描述文档和代码同样重要。审阅者可以从描述中，而不仅仅是从代码中，了解问题和解决方案。 - - 勾选是否完成了对应的 Checklist。 - + - 新建 `PR` 时请仔细描述此贡献，描述文档和代码同样重要。审阅者可以从描述中，而不仅仅是从代码中，了解问题和解决方案。 + - 勾选是否完成了对应的 Checklist。 3. 建议一次 `PR` 只包含一个功能/一种修复/一类改进/一种重构/一次清理/一类文档等 - 4. 提交消息(英文，小写，无特殊字符) - 消息的提交应遵循与 `PR` 类似的模式：`[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + 消息的提交应遵循与 `PR` 类似的模式：`[feature/bugfix/doc/improve/refactor/bug/cleanup] title` ## 2 代码检查样式 @@ -69,81 +66,79 @@ sidebar_position: 3 ### 3.1 命名风格 1. 优先为变量命名选择名词，这样更容易区分`变量`或`方法`。 + ```java - Cache publicKeyCache; + Cache publicKeyCache; ``` - 2. 变量的拼音缩写是禁止的（排除地名等名词），例如chengdu。 - 3. 推荐的变量名以 `类型` 结尾。 对于 `Collection/List` 类型的变量，取 `xxxx` （复数表示多个元素）或以 `xxxList` （特定类型）结束。 对于 `map` 类型的变量，清晰地描述 `key` 和 `value`： + ```java - Map idUserMap; - Map userIdNameMap; + Map idUserMap; + Map userIdNameMap; ``` - 4. 通过其名称直观地知道变量的类型和含义。 方法名称应首先以动词开始，如下所示： + ```java - void computeVcores(Object parameter1); + void computeVcores(Object parameter1); ``` - > 注意：在 `Builder` 工具类中不必严格遵循这项规则。 - + > 注意：在 `Builder` 工具类中不必严格遵循这项规则。 ### 3.2 常量变量定义 1. 多余的字符串应提取为常量 - >如果一个常量被硬编码两次或多次，请直接提取它为常量并更改相应的引用。 - 通常，`log` 中的常量可以忽略提取。 - - - 负面示例： - - ```java - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put("status", "success"); - resp.put("code", ResponseCode.CODE_SUCCESS); - resp.put("data", data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put("status", "error"); - resp.put("code", ResponseCode.CODE_FAIL); - resp.put("data", null); - return resp; - } - ``` - - - 正面示例： - - > 字符串提取为常量引用。 - - ```java - public static final String STATUS = "status"; - public static final String CODE = "code"; - public static final String DATA = "data"; - - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "success"); - resp.put(CODE, ResponseCode.CODE_SUCCESS); - resp.put(DATA, data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "error"); - resp.put(CODE, ResponseCode.CODE_FAIL); - resp.put(DATA, null); - return resp; - } - ``` + > 如果一个常量被硬编码两次或多次，请直接提取它为常量并更改相应的引用。 + > 通常，`log` 中的常量可以忽略提取。 + + - 负面示例： + + ```java + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put("status", "success"); + resp.put("code", ResponseCode.CODE_SUCCESS); + resp.put("data", data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put("status", "error"); + resp.put("code", ResponseCode.CODE_FAIL); + resp.put("data", null); + return resp; + } + ``` + - 正面示例： + + > 字符串提取为常量引用。 + + ```java + public static final String STATUS = "status"; + public static final String CODE = "code"; + public static final String DATA = "data"; + + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "success"); + resp.put(CODE, ResponseCode.CODE_SUCCESS); + resp.put(DATA, data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "error"); + resp.put(CODE, ResponseCode.CODE_FAIL); + resp.put(DATA, null); + return resp; + } + ``` 2. 确保代码的可读性和直观性 - `annotation` 符号中的字符串不需要提取为常量。 @@ -155,9 +150,9 @@ sidebar_position: 3 4. 关于 `constant/variable` 行的排序顺序 按以下顺序对类中的变量行进行排序： - 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` - 2. `public static v`, `static v`,`protected static v`, `private static v` - 3. `public v`, `v`, `protected v`, `private v` + 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` + 2. `public static v`, `static v`,`protected static v`, `private static v` + 3. `public v`, `v`, `protected v`, `private v` ### 3.3 方法规则 @@ -174,32 +169,28 @@ sidebar_position: 3 3. 如果方法中的代码行数太多，请尝试在适当的点上使用多个子方法来分段方法体。 一般来说，需要坚持以下原则： - - 便于测试 - - 有好的语义 - - 易于阅读 + - 便于测试 + - 有好的语义 + - 易于阅读 此外，还需要考虑在组件、逻辑、抽象和场景等方面的切割是否合理。 > 然而，目前还没有明确的演示定义。在演变过程中，我们将为开发者提供更多的示例，以便他们有更清晰的参考和理解。 - ### 3.4 集合规则 1. 对于返回的 `collection` 值，除非有特殊的 `concurrent` (如线程安全)，总是返回 `interface`，例如： - - - 如果使用 `ArrayList`，则返回 List - - 如果使用 `HashMap`，则返回 Map - - 如果使用 `HashSet`，则返回 Set - + - 如果使用 `ArrayList`，则返回 List + - 如果使用 `HashMap`，则返回 Map + - 如果使用 `HashSet`，则返回 Set 2. 如果存在多线程，可以使用以下声明或返回类型： - ```java - private CurrentHashMap map; - public CurrentHashMap funName(); - ``` +```java +private CurrentHashMap map; +public CurrentHashMap funName(); +``` 3. 使用 `isEmpty()` 而不是 `length() == 0` 或者 `size() == 0` - - 负面示例： ```java @@ -207,7 +198,6 @@ sidebar_position: 3 return; } ``` - - 正面示例： ```java @@ -227,9 +217,8 @@ sidebar_position: 3 ### 3.6 控制/条件语句 1. 避免因不合理的 `条件/控制` 分支顺序导致： - - - 多个代码行的 `深度` 为 `n+1` - - 多余的行 + - 多个代码行的 `深度` 为 `n+1` + - 多余的行 一般来说，如果一个方法的代码行深度由于连续嵌套的 `if... else..` 超过了 `2+ Tabs`，那么应该考虑试图 - `合并分支`， @@ -238,77 +227,85 @@ sidebar_position: 3 以减少代码行深度并提高可读性，例如： - 联合或将逻辑合并到下一级调用中 - - 负面示例： - ```java - if (isInsert) { - save(platform); - } else { - updateById(platform); - } - ``` - - 正面示例： - ```java - saveOrUpdate(platform); - ``` +- 负面示例： + +```java +if (isInsert) { +save(platform); +} else { +updateById(platform); +} +``` + +- 正面示例： + +```java +saveOrUpdate(platform); +``` + - 合并条件 - - 负面示例： - ```java - if (expression1) { - if(expression2) { - ...... - } - } - ``` - - 正面示例： - ```java - if (expression1 && expression2) { - ...... - } - ``` +- 负面示例： + +```java +if (expression1) { +if(expression2) { +...... +} +} + +``` + +- 正面示例： + + ```java + if (expression1 && expression2) { + ...... + } + ``` - 反转条件 - - 负面示例： - - ```java - public void doSomething() { - // 忽略更深的代码块行 - // ..... - if (condition1) { - ... - } else { - ... - } - } - ``` - - - 正面示例： - - ```java - public void doSomething() { - // 忽略更深的代码块行 - // ..... - if (!condition1) { - ... - return; - } - // ... - } - ``` +- 负面示例： + + ```java + public void doSomething() { + // 忽略更深的代码块行 + // ..... + if (condition1) { + ... + } else { + ... + } + } + ``` +- 正面示例： + + ```java + public void doSomething() { + // 忽略更深的代码块行 + // ..... + if (!condition1) { + ... + return; + } + // ... + } + ``` - 使用单一变量或方法减少复杂的条件表达式 - - 负面示例： - ```java - if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { - ... - } - ``` - - - 正面示例： - ```java - if (containsSqlServer(dbType)) { - .... - } - //..... - // containsSqlServer的定义 - ``` +- 负面示例： + + ```java + if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { + ... + } + ``` +- 正面示例： + + ```java + if (containsSqlServer(dbType)) { + .... + } + //..... + // containsSqlServer的定义 + ``` > 在未来，使用 `sonarlint` 和 `better highlights` 检查代码深度看起来是个不错的选择。 @@ -316,20 +313,20 @@ sidebar_position: 3 1. 方法缺少注释： - - `When`：该方法何时可以被调用 - - `How`：如何使用此方法以及如何传递参数等 - - `What`：此方法实现了哪些功能 - - `Note`：在调用此方法时开发人员应注意什么 +- `When`：该方法何时可以被调用 +- `How`：如何使用此方法以及如何传递参数等 +- `What`：此方法实现了哪些功能 +- `Note`：在调用此方法时开发人员应注意什么 2. 缺少必要的类头部描述注释。 - 添加 `What`，`Note` 等，如上述 `1` 中提到的。 +添加 `What`，`Note` 等，如上述 `1` 中提到的。 3. 在接口中的方法声明必须被注释。 - - 如果实现的语义和接口声明的注释内容不一致，则具体的实现方法也需要用注释重写。 +- 如果实现的语义和接口声明的注释内容不一致，则具体的实现方法也需要用注释重写。 - - 如果方法实现的语义与接口声明的注释内容一致，则建议不写注释以避免重复的注释。 +- 如果方法实现的语义与接口声明的注释内容一致，则建议不写注释以避免重复的注释。 4. 在注释行中的第一个词需要大写，如 `param` 行，`return` 行。 如果特殊引用作为主题不需要大写，需要注意特殊符号，例如引号。 @@ -339,31 +336,29 @@ sidebar_position: 3 1. 更倾向于使用 `non-capturing` lambda（不包含对外部范围的引用的lambda）。 Capturing lambda 在每次调用时都需要创建一个新的对象实例。`Non-capturing` lambda 可以为每次调用使用相同的实例。 - - 负面示例： +- 负面示例： - ```java - map.computeIfAbsent(key, x -> key.toLowerCase()) - ``` - - - 正面示例： + ```java + map.computeIfAbsent(key, x -> key.toLowerCase()) + ``` +- 正面示例： - ```java - map.computeIfAbsent(key, k -> k.toLowerCase()); - ``` + ```java + map.computeIfAbsent(key, k -> k.toLowerCase()); + ``` 2. 考虑使用方法引用而不是内联lambda - - 负面示例： - - ```java - map.computeIfAbsent(key, k-> Loader.load(k)); - ``` +- 负面示例： - - 正面示例： + ```java + map.computeIfAbsent(key, k-> Loader.load(k)); + ``` +- 正面示例： - ```java - map.computeIfAbsent(key, Loader::load); - ``` + ```java + map.computeIfAbsent(key, Loader::load); + ``` ### 3.9 Java Streams @@ -381,186 +376,180 @@ sidebar_position: 3 1. 使用 `StringUtils.isBlank` 而不是 `StringUtils.isEmpty` - - 负面示例： - - ```java - if (StringUtils.isEmpty(name)) { - return; - } - ``` +- 负面示例： - - 正面示例： + ```java + if (StringUtils.isEmpty(name)) { + return; + } + ``` +- 正面示例： - ```java - if (StringUtils.isBlank(name)) { - return; - } - ``` + ```java + if (StringUtils.isBlank(name)) { + return; + } + ``` 2. 使用 `StringUtils.isNotBlank` 而不是 `StringUtils.isNotEmpty` - - 负面示例： - - ```java - if (StringUtils.isNotEmpty(name)) { - return; - } - ``` +- 负面示例： - - 正面示例： + ```java + if (StringUtils.isNotEmpty(name)) { + return; + } + ``` +- 正面示例： - ```java - if (StringUtils.isNotBlank(name)) { - return; - } - ``` + ```java + if (StringUtils.isNotBlank(name)) { + return; + } + ``` 3. 使用 `StringUtils.isAllBlank` 而不是 `StringUtils.isAllEmpty` - - 负面示例： - - ```java - if (StringUtils.isAllEmpty(name, age)) { - return; - } - ``` +- 负面示例： - - 正面示例： + ```java + if (StringUtils.isAllEmpty(name, age)) { + return; + } + ``` +- 正面示例： - ```java - if (StringUtils.isAllBlank(name, age)) { - return; - } - ``` + ```java + if (StringUtils.isAllBlank(name, age)) { + return; + } + ``` ### 3.12 `Enum` 类 1. 枚举值比较 - - 负面示例： +- 负面示例： - ```java - if (status.equals(JobStatus.RUNNING)) { - return; - } - ``` - - - 正面示例： + ```java + if (status.equals(JobStatus.RUNNING)) { + return; + } + ``` +- 正面示例： - ```java - if (status == JobStatus.RUNNING) { - return; - } - ``` + ```java + if (status == JobStatus.RUNNING) { + return; + } + ``` 2. 枚举类不需要实现 Serializable - - 负面示例： - - ```java - public enum JobStatus implements Serializable { - ... - } - ``` +- 负面示例： - - 正面示例： + ```java + public enum JobStatus implements Serializable { + ... + } + ``` +- 正面示例： - ```java - public enum JobStatus { - ... - } - ``` + ```java + public enum JobStatus { + ... + } + ``` 3. 使用 `Enum.name()` 而不是 `Enum.toString()` - - 负面示例： - - ```java - System.out.println(JobStatus.RUNNING.toString()); - ``` +- 负面示例： - - 正面示例： + ```java + System.out.println(JobStatus.RUNNING.toString()); + ``` +- 正面示例： - ```java - System.out.println(JobStatus.RUNNING.name()); - ``` + ```java + System.out.println(JobStatus.RUNNING.name()); + ``` 4. 枚举类名称统一使用 Enum 后缀 - - 负面示例： +- 负面示例： - ```java - public enum JobStatus { - ... - } - ``` - - - 正面示例： + ```java + public enum JobStatus { + ... + } + ``` +- 正面示例： - ```java - public enum JobStatusEnum { - ... - } - ``` + ```java + public enum JobStatusEnum { + ... + } + ``` ### 3.13 `Deprecated` 注解 - - 负面示例: +- 负面示例: - ```java - @deprecated - public void process(String input) { - ... - } - ``` +```java +@deprecated +public void process(String input) { + ... +} +``` - - 正面示例: +- 正面示例: - ```java - @Deprecated - public void process(String input) { - ... - } - ``` +```java +@Deprecated +public void process(String input) { + ... +} +``` ## 4 日志 1. 使用 `占位符` 进行日志输出： - - 负面示例 - ```java - log.info("Deploy cluster request " + deployRequest); - ``` - - 正面示例 - ```java - log.info("load plugin:{} to {}", file.getName(), appPlugins); - ``` +- 负面示例 -2. 打印日志时，注意选择 `日志级别` + ```java + log.info("Deploy cluster request " + deployRequest); + ``` +- 正面示例 - 当打印日志内容时，如果传递了日志占位符的实际参数，必须避免过早评估，以避免由日志级别导致的不必要评估。 + ```java + log.info("load plugin:{} to {}", file.getName(), appPlugins); + ``` - - 负面示例： +2. 打印日志时，注意选择 `日志级别` - 假设当前日志级别为 `INFO`： +当打印日志内容时，如果传递了日志占位符的实际参数，必须避免过早评估，以避免由日志级别导致的不必要评估。 - ```java - // 忽略声明行。 - List userList = getUsersByBatch(1000); - LOG.debug("All users: {}", getAllUserIds(userList)); - ``` +- 负面示例： - - 正面示例： + 假设当前日志级别为 `INFO`： - 在这种情况下，我们应该在进行实际的日志调用之前提前确定日志级别，如下所示： + ```java + // 忽略声明行。 + List userList = getUsersByBatch(1000); + LOG.debug("All users: {}", getAllUserIds(userList)); + ``` +- 正面示例： - ```java - // 忽略声明行。 - List userList = getUsersByBatch(1000); - if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); - } - ``` + 在这种情况下，我们应该在进行实际的日志调用之前提前确定日志级别，如下所示： + + ```java + // 忽略声明行。 + List userList = getUsersByBatch(1000); + if (LOG.isDebugEnabled()) { + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + } + ``` ## 5 测试 @@ -568,10 +557,15 @@ sidebar_position: 3 2. 实现的接口需在`e2e`模块下编写`e2e`测试用例脚本。 - ## 参考资料 + - https://site.mockito.org/ - https://alibaba.github.io/p3c/ - https://rules.sonarsource.com/java/ - https://junit.org/junit5/ - https://streampark.apache.org/ + +``` + +``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md index 6167d13aa5f..0c574937517 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md @@ -1,8 +1,9 @@ --- id: contact title: 交流联系 -sidebar_label: 交流联系 +sidebar_label: 交流联系 --- + > 如果您在使用过程有任何需要帮助或者想交流建议，可以通过 群 ISSUE 讨论交流。 [订阅邮件列表](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) : 发送邮件至 `dev-subscribe@hertzbeat.apache.org` 来订阅邮件列表. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md index 6df2d242220..55993958797 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md @@ -5,20 +5,20 @@ sidebar_position: 0 --- > 非常欢迎参与项目贡献，我们致力于维护一个互相帮助的快乐社区。 @@ -87,23 +87,31 @@ sidebar_position: 0 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 和其他贡献者进行代码审查。 @@ -148,14 +156,15 @@ git pull upstream master ### 模块 - **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务 + > 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。 -- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 +> - **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 > 使用通用协议远程采集获取对端指标数据。 -- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 +> - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 > 采集指标结果数据管理，数据落盘，查询，计算统计。 -- **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 +> - **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 > 告警计算触发，任务状态联动，告警配置，告警通知。 -- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 +> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 > 监控告警系统可视化控制台前端 ![hertzBeat](/img/docs/hertzbeat-arch.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md index 2bfebd21d2f..c9ed4b45859 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md @@ -1,7 +1,7 @@ --- id: development title: 如何将 HertzBeat 运行编译? -sidebar_label: 运行编译 +sidebar_label: 运行编译 --- ## 让 HertzBeat 运行起来 @@ -9,7 +9,6 @@ sidebar_label: 运行编译 > 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 - ### 后端启动 1. 需要 `maven3+`, `java17` 和 `lombok` 环境 @@ -38,7 +37,7 @@ sidebar_label: 运行编译 ## 生成二进制包 -> 需要 `maven3+`, `java17`, `node` 和 `yarn` 环境. +> 需要 `maven3+`, `java17`, `node` 和 `yarn` 环境. ### 前端打包 @@ -52,7 +51,6 @@ sidebar_label: 运行编译 5. 打包: `yarn package` - ### 后端打包 1. 需要 `maven3+`, `java17` 环境 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md index e696b3c35e4..4cf56e0137b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- 对于任何类型的软件来说，良好的文档都是至关重要的。任何能够改进 HertzBeat 文档的贡献都是受欢迎的。 @@ -93,3 +93,4 @@ css 和其他样式文件放在 `src/css` 目录中。 ### 页面内容修改 > 所有页面文档都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md index 541444473d2..2cccecd681c 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 @@ -12,7 +12,7 @@ sidebar_position: 4 - JDK 17 - Node18 Yarn -- Apache Maven 3.x +- Apache Maven 3.x - GnuPG 2.x - Git - SVN (Apache使用svn来托管项目发布) @@ -22,11 +22,11 @@ sidebar_position: 4 ## 2. 准备发布 > 首先整理帐户信息以更好地了解操作过程，稍后会多次使用。 -- apache id: `muchunjin (APACHE LDAP 用户名)` -- apache passphrase: `APACHE LDAP 密钥` -- apache email: `muchunjin@apache.org` -- gpg real name: `muchunjin (任何名称均可用, 在这里我将其设置为与apache id相同的名称)` -- gpg key passphrase: `创建gpg密钥时设置的密码，你需要记住此密码` +> - apache id: `muchunjin (APACHE LDAP 用户名)` +> - apache passphrase: `APACHE LDAP 密钥` +> - apache email: `muchunjin@apache.org` +> - gpg real name: `muchunjin (任何名称均可用, 在这里我将其设置为与apache id相同的名称)` +> - gpg key passphrase: `创建gpg密钥时设置的密码，你需要记住此密码` ### 2.1 生成密钥 @@ -130,7 +130,6 @@ gpg: unchanged: 1 或者进入 https://keyserver.ubuntu.com/ 网址，输入密钥的名称，然后点击'Search key' 按钮，查看是否有对应名称的密钥。 - #### 2.4 将 gpg 公钥添加到 Apache SVN 项目仓库的 KEYS 文件中 - Apache HertzBeat Dev 分支 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat @@ -230,9 +229,9 @@ release-1.6.0-rc1 #### 3.5 对二进制和源码包进行签名 -将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。 +将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录)，然后对文件包进行签名和SHA512校验和生成。 -> 其中 `gpg -u 33545C76` 的 `33545C76` 是你的 GPG 密钥 ID，可以通过 `gpg --keyid-format SHORT --list-keys` 查看。 +> 其中 `gpg -u 33545C76` 的 `33545C76` 是你的 GPG 密钥 ID，可以通过 `gpg --keyid-format SHORT --list-keys` 查看。 ```shell cd dist @@ -341,7 +340,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" > `Send to`: dev@hertzbeat.apache.org
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
-> `Body`: +> `Body`: ``` Hello HertzBeat Community: @@ -404,8 +403,7 @@ Dear HertzBeat community, Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" I'm happy to announce the vote has passed: - - +--- 4 binding +1, from: - cc @@ -413,24 +411,20 @@ I'm happy to announce the vote has passed: 1 non-binding +1, from: - Roc Marshal - - +--- no 0 or -1 votes. Vote thread: https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq - - +--- Thank you to everyone who helped us to verify and vote for this release. We will move to the ASF Incubator voting shortly. - - +--- Best, ChunJin Mu ``` 邮件内容中的一项是`Vote thread`，在 https://lists.apache.org/list.html?dev@hertzbeat.apache.org 查看获取 - #### 3.2 发送孵化社区投票邮件 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。 @@ -476,17 +470,14 @@ More detailed checklist please refer: Steps to validate the release， Please refer to: • https://www.apache.org/info/verification.html • https://hertzbeat.apache.org/docs/community/how_to_verify_release - - +--- How to Build: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package - - +--- Thanks, On behalf of Apache HertzBeat (incubating) community - - +--- Best, ChunJin Mu ``` @@ -562,11 +553,14 @@ https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugi 然后输入发版标题和描述 -- 发版标题: +- 发版标题: + ``` v1.6.0 ``` + - 描述: + ``` xxx release note: xxx @@ -597,8 +591,7 @@ Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues - Mailing list: dev@hertzbeat.apache.org - - +--- Apache HertzBeat Team Best, @@ -607,6 +600,6 @@ ChunJin Mu 该版本的发布顺利结束。 ----- +--- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md index ee4f9563c83..9904af1967b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md @@ -3,6 +3,7 @@ id: how_to_verify_release title: 版本物料的验证 sidebar_position: 4 --- + # 验证候选版本 详细检查列表请参考官方的[check list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist) @@ -21,12 +22,10 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio ``` - ## 2. 验证上传的版本是否合规 > 开始验证环节，验证包含但不局限于以下内容和形式 - ### 2.1 查看发布包是否完整 > 上传到dist的包必须包含源码包，二进制包可选 @@ -36,7 +35,6 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio 3. 是否包含源码包的sha512 4. 如果上传了二进制包，则同样检查(2)-(4)所列的内容 - ### 2.2 检查gpg签名 首先导入发布人公钥。从svn仓库导入KEYS到本地环境。（发布版本的人不需要再导入，帮助做验证的人需要导入，用户名填发版人的即可） @@ -47,6 +45,7 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio $ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS $ gpg --import KEYS # 导入KEYS到本地 ``` + #### 2.2.2 信任公钥 > 信任此次版本所使用的KEY @@ -75,6 +74,7 @@ Do you really want to set this key to ultimate trust? (y/N) y #选择y gpg> ``` + #### 2.2.3 检查签名 ```shell @@ -82,6 +82,7 @@ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done ``` 检查结果 + > 出现类似以下内容则说明签名正确，关键字：**`Good signature`** ```shell @@ -95,7 +96,6 @@ gpg: Good signature from "xxx @apache.org>" > 本地计算sha512哈希后，验证是否与dist上的一致，如果上传二进制包，则同样需要检查二进制包的sha512哈希 - ```shell for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done ``` @@ -123,7 +123,6 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz 参考: https://apache.org/legal/resolved.html - ### 2.5. 源码编译验证 解压缩 `apache-hertzbeat-${release_version}-incubating-src.tar.gz` @@ -132,7 +131,7 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz cd apache-hertzbeat-${release_version}-incubating-src ``` -编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package +编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package 进行如下检查: @@ -148,7 +147,6 @@ cd apache-hertzbeat-${release_version}-incubating-src 参考: https://apache.org/legal/resolved.html - ## 3. 邮件回复 如果发起了发布投票，验证后，可以参照此回复示例进行邮件回复 @@ -169,11 +167,11 @@ IPMC 在 general@incubator.apache.org incubator 社区投票，请带上 binding Forward my +1 from dev@hertzbeat (non-binding) Copy my +1 from hertzbeat DEV ML (non-binding) ``` -::: - +::: 非PPMC/IPMC成员 + ```html +1 (non-binding) I checked: @@ -185,6 +183,7 @@ I checked: ``` PPMC/IPMC成员 + ```html //incubator社区 投票时，只有IPMC成员才具有约束性 binding +1 (binding) @@ -196,7 +195,6 @@ I checked: 5. .... ``` - --- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md index 57de5409834..922cbfe9a6a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- [开发者邮件列表](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) 是社区推荐的沟通和获取最新信息的方式。 @@ -32,19 +32,17 @@ sidebar_position: 1 - 使用此列表提出您对 HertzBeat 的问题 - 由 HertzBeat 贡献者用来讨论 HertzBeat 的开发 - -| 列表名称 | 地址 | 订阅 | 退订 | 归档 | -|--------------|------------------------------|------------------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------------| -| **开发者列表** | dev@hertzbeat.apache.org | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | - +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|-----------|--------------------------|-------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------| +| **开发者列表** | dev@hertzbeat.apache.org | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | ### 通知列表 - 关于 HertzBeat 代码库的更改的通知，频繁通知 -| 列表名称 | 地址 | 订阅 | 退订 | 归档 | -|-----------|------------------------------|-------------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------| -| **通知列表** | notifications@hertzbeat.apache.org | [订阅](mailto:notifications-subscribe@hertzbeat.apache.org) | [退订](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|----------|------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------| +| **通知列表** | notifications@hertzbeat.apache.org | [订阅](mailto:notifications-subscribe@hertzbeat.apache.org) | [退订](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | ## 订阅步骤 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md index 188b68b3688..489215891e7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md @@ -5,20 +5,20 @@ sidebar_position: 4 --- [官方指南](https://community.apache.org/newcommitter.html#new-committer-process) @@ -50,7 +50,6 @@ sidebar_position: 4 - 等待root告诉我们已经完成 - PMC主席开启svn和其他访问权限 - 在JIRA和CWiki中将Committer添加到适当的组中 - - 通知Committer完成 参见 **Committer完成模板** @@ -243,3 +242,4 @@ you can now help fix that. A PPMC member will announce your election to the dev list soon. ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md index 4488f1fcfea..d7e144bb52b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md @@ -5,20 +5,20 @@ sidebar_position: 5 --- 这个指南是基于 [apache newcommitter](https://community.apache.org/newcommitter.html#new-committer-process) 的。 @@ -82,7 +82,6 @@ ${Work list}[1] [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) [Apache 参考投票指南](https://community.apache.org/newcommitter.html) - ### Close Vote Template ```text @@ -284,3 +283,4 @@ A PPMC member helps manage and guide the direction of the project. Thanks, On behalf of the Apache HertzBeat (incubating) PPMC ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md index ee553bb6e1c..8940571f71c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md @@ -5,72 +5,64 @@ sidebar_position: 2 --- - * 首先从远程仓库 将代码的一份副本 fork 到您自己的仓库 * 远程仓库开发合并分支：`master` * 将您fork仓库clone到您的本地设备 - ```shell - git clone git@github.com:<您的账户名>/hertzbeat.git - ``` - + ```shell + git clone git@github.com:<您的账户名>/hertzbeat.git + ``` * 添加远程仓库地址，命名为 upstream - ```shell - git remote add upstream git@github.com:apache/hertzbeat.git - ``` - + ```shell + git remote add upstream git@github.com:apache/hertzbeat.git + ``` * 查看仓库 - ```shell - git remote -v - ``` + ```shell + git remote -v + ``` > 此时会有两个仓库：origin（您自己的仓库）和 upstream（远程仓库） * 获取/更新远程仓库代码 - ```shell - git fetch upstream - ``` - + ```shell + git fetch upstream + ``` * 将远程仓库代码同步到本地仓库 - ```shell - git checkout origin/master - git merge --no-ff upstream/master - ``` - + ```shell + git checkout origin/master + git merge --no-ff upstream/master + ``` * **⚠️注意一定要新建分支开发特性 `git checkout -b feature-xxx`，不建议使用master分支直接开发** - * 在本地修改代码后，提交到自己的仓库： - **注意提交信息为英文，不包含特殊字符** - ```shell - git commit -m '[docs]necessary instructions' - git push - ``` + **注意提交信息为英文，不包含特殊字符** + ```shell + git commit -m '[docs]necessary instructions' + git push + ``` * 将更改提交到远程仓库后，您可以在您的仓库页面上看到一个绿色的按钮“Compare & pull request”，点击它。 - * 这会弹出新建 Pull Request 页面，您需要这里仔细填写信息(英文)，描述和代码同样重要，然后点击“Create pull request”按钮。 - * 然后社区的 Committers 将进行 CodeReview，并与您讨论一些细节（包括设计、实现、性能等），之后您可以根据建议直接在这个分支更新代码(无需新建PR)。当社区 Committer approve之后，提交将被合并到 master 分支。 - * 最后，恭喜您，您已经成为 HertzBeat 的官方贡献者，您会被加在贡献者墙上，您可以联系社区获取贡献者证书！ + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md index 7ce72412d0b..11455bfa3d1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md @@ -18,11 +18,9 @@ sidebar_label: Download 以前版本的 HertzBeat 可能会受到安全问题的影响，请考虑使用最新版本。 ::: - -| 版本 | 日期 | 下载 | Release Notes | -|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| -| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | - +| 版本 | 日期 | 下载 | Release Notes | +|--------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | ## 归档版本 @@ -34,3 +32,4 @@ sidebar_label: Download - HertzBeat https://hub.docker.com/r/apache/hertzbeat - HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md index b2d8f1489f5..29d5478158a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 **使用协议：JMX** -### 监控前操作 +### 监控前操作 > 您需要在 ActiveMQ 开启 `JMX` 服务，HertzBeat 使用 JMX 协议对 ActiveMQ 进行指标采集。 @@ -23,9 +23,10 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 ``` -2. 修改安装目录下的 `bin/env` 文件，配置JMX 端口 IP等 +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" @@ -34,7 +35,9 @@ keywords: [开源监控系统, 开源中间件监控, ActiveMQ消息中间件监 ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" ``` -更新为如下配置，⚠️注意修改`本机对外IP` + +更新为如下配置，⚠️注意修改`本机对外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" @@ -49,25 +52,25 @@ 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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 监控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. | @@ -88,57 +91,56 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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 | - +#### 指标集合：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 | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md index 5323ede8110..52367155d89 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md @@ -9,33 +9,31 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：airflow_health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | -------------------- | -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|------------------| +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | #### 指标集合：airflow_version -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | --------------- | -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------| +| value | 无 | Airflow版本 | +| git_version | 无 | Airflow git版本 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_console.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_console.md index 68cf7339eae..5198b961b66 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_console.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_console.md @@ -6,13 +6,13 @@ sidebar_label: 告警模板登录台地址 > 阈值触发后发送告警信息，通过钉钉/企业微信/飞书机器人通知或者使用邮箱通知的时候，告警内容中有登录控制台的详情链接 - ### 自定义设置 在我们的启动配置文件application.yml中，找到下面的配置 + ```yml alerter: console-url: #这里就是我们的自定义控制台地址 ``` -默认值是赫兹跳动的官方控制台地址 \ No newline at end of file +默认值是赫兹跳动的官方控制台地址 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md index aec6342f7d3..9d0ee3b088f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md @@ -5,15 +5,15 @@ sidebar_label: 告警钉钉机器人通知 keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 +> 阈值触发后发送告警信息，通过钉钉机器人通知到接收人。 -### 操作步骤 +### 操作步骤 1. **【钉钉桌面客户端】-> 【群设置】-> 【智能群助手】-> 【添加新建机器人-选自定义】-> 【设置机器人名称头像】-> 【注意⚠️设置自定义关键字: HertzBeat】 ->【添加成功后复制其WebHook地址】** -> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 +> 注意⚠️ 新增机器人时需在安全设置块需设置其自定义关键字: HertzBeat ，其它安全设置加签或IP段不填写 -![email](/img/docs/help/alert-notice-8.png) +![email](/img/docs/help/alert-notice-8.png) 2. **【保存机器人的WebHook地址access_token值】** @@ -24,18 +24,18 @@ keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警 ![email](/img/docs/help/alert-notice-9.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 钉钉机器人通知常见问题 -### 钉钉机器人通知常见问题 +1. 钉钉群未收到机器人告警通知 -1. 钉钉群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查钉钉机器人是否配置了安全自定义关键字：HertzBeat > 请排查是否配置正确机器人ACCESS_TOKEN，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md index d6c4879a2ba..9694126d0dd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md @@ -5,68 +5,66 @@ sidebar_label: 告警 Discord 机器人通知 keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 +> 阈值触发后发送告警信息，通过 Discord 机器人通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 -### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token +### 在 Discord 创建应用, 应用下创建机器人, 获取机器人 Token -1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 +1. 访问 [https://discord.com/developers/applications](https://discord.com/developers/applications) 创建应用 ![bot](/img/docs/help/discord-bot-1.png) -2. 在应用下创建机器人，获取机器人 Token +2. 在应用下创建机器人，获取机器人 Token ![bot](/img/docs/help/discord-bot-2.png) ![bot](/img/docs/help/discord-bot-3.png) -3. 授权机器人到聊天服务器 +3. 授权机器人到聊天服务器 -> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` +> 在 OAuth2 菜单下给此机器人授权，`SCOPES` 范围选 `bot`, `BOT PERMISSIONS` 选发送消息 `Send Messages` ![bot](/img/docs/help/discord-bot-4.png) > 获取到最下方生成的 URL, 浏览器访问此 URL 给机器人正式授权，即设置将机器人加入哪个聊天服务器。 -4. 查看您的聊天服务器是否已经加入机器人成员 +4. 查看您的聊天服务器是否已经加入机器人成员 ![bot](/img/docs/help/discord-bot-5.png) -### 开启开发者模式，获取频道 Channel ID +### 开启开发者模式，获取频道 Channel ID -1. 个人设置 -> 高级设置 -> 开启开发者模式 +1. 个人设置 -> 高级设置 -> 开启开发者模式 ![bot](/img/docs/help/discord-bot-6.png) -2. 获取频道 Channel ID +2. 获取频道 Channel ID -> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID +> 右键选中您想要发送机器人消息的聊天频道，点击 COPY ID 按钮获取 Channel ID ![bot](/img/docs/help/discord-bot-7.png) - -### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot +### 在 HertzBeat 新增告警通知人，通知方式为 Discord Bot 1. **【告警通知】->【新增接收人】 ->【选择 Discord 机器人通知方式】->【设置机器人Token和ChannelId】-> 【确定】** ![email](/img/docs/help/discord-bot-8.png) -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -![email](/img/docs/help/alert-notice-policy.png) +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +![email](/img/docs/help/alert-notice-policy.png) -### Discord 机器人通知常见问题 +### Discord 机器人通知常见问题 -1. Discord 未收到机器人告警通知 +1. Discord 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 > 请排查机器人是否被 Discord聊天服务器正确赋权 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md index 7033f6036d6..d4dc218c591 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md @@ -5,34 +5,35 @@ sidebar_label: 告警邮件通知 keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过邮件通知到接收人。 +> 阈值触发后发送告警信息，通过邮件通知到接收人。 -### 操作步骤 +### 操作步骤 -1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** +1. **【告警通知】->【新增接收人】 ->【选择邮件通知方式】** -![email](/img/docs/help/alert-notice-1.png) +![email](/img/docs/help/alert-notice-1.png) 2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** -![email](/img/docs/help/alert-notice-2.png) + ![email](/img/docs/help/alert-notice-2.png) -![email](/img/docs/help/alert-notice-3.png) +![email](/img/docs/help/alert-notice-3.png) -3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 邮件通知常见问题 -### 邮件通知常见问题 +1. 自己内网部署的HertzBeat无法接收到邮件通知 -1. 自己内网部署的HertzBeat无法接收到邮件通知 -> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 +> HertzBeat需要自己配置邮件服务器，TanCloud无需，请确认是否在application.yml配置了自己的邮件服务器 + +2. 云环境TanCloud无法接收到邮件通知 -2. 云环境TanCloud无法接收到邮件通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确邮箱，是否已配置告警策略关联 -> 请查询邮箱的垃圾箱里是否把告警邮件拦截 +> 请查询邮箱的垃圾箱里是否把告警邮件拦截 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md index 3f1c5a2b9c1..b70c8b10c40 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md @@ -5,28 +5,28 @@ sidebar_label: 企业微信应用告警通知 keywords: [开源告警系统, 开源监控告警系统, 企业微信应用告警通知] --- -> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. +> 阈值触发后发送告警信息，通过企业微信应用通知到接收人. -### Operation steps +### Operation steps 1. **【企业微信后台管理】-> 【App管理】-> 【创建一个新的应用】-> 【设置应用信息】->【添加成功后复制应用的AgentId和Secret】** -![email](/img/docs/help/alert-wechat-1.jpg) +![email](/img/docs/help/alert-wechat-1.jpg) 2. **【告警通知】->【新增接收人】 ->【选择企业微信应用通知方式】->【设置企业ID,企业应用id和应用的secret 】-> 【确定】** ![email](/img/docs/help/alert-wechat-2.jpg) -3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人。** -![email](/img/docs/help/alert-wechat-3.jpg) +![email](/img/docs/help/alert-wechat-3.jpg) +### 企业微信应用通知常见问题 -### 企业微信应用通知常见问题 +1. 企业微信应用未收到告警通知. -1. 企业微信应用未收到告警通知. > 请检查用户是否具有应用程序权限. > 请检查企业应用程序回调地址设置是否正常. > 请检查服务器IP是否在企业应用程序白名单上. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md index 448e70de223..604eff34fdc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md @@ -5,30 +5,30 @@ sidebar_label: 告警飞书机器人通知 keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 +> 阈值触发后发送告警信息，通过飞书机器人通知到接收人。 -### 操作步骤 +### 操作步骤 1. **【飞书客户端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** -2. **【保存机器人的WebHook地址的KEY值】** +2. **【保存机器人的WebHook地址的KEY值】** > 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 飞书机器人通知常见问题 -### 飞书机器人通知常见问题 +1. 飞书群未收到机器人告警通知 -1. 飞书群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 +> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md index e137d07e9e2..c81f5608674 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md @@ -5,34 +5,33 @@ sidebar_label: 告警 Slack Webhook 通知 keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 +> 阈值触发后发送告警信息，通过 Slack Webhook 通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 -### 在 Slack 开启 Webhook, 获取 Webhook URL +### 在 Slack 开启 Webhook, 获取 Webhook URL -参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) +参考官网文档 [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks) -### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook +### 在 HertzBeat 新增告警通知人，通知方式为 Slack Webhook 1. **【告警通知】->【新增接收人】 ->【选择 Slack Webhook 通知方式】->【设置 Webhook URL】-> 【确定】** ![email](/img/docs/help/slack-bot-1.png) -2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 -![email](/img/docs/help/alert-notice-policy.png) +![email](/img/docs/help/alert-notice-policy.png) +### Slack 机器人通知常见问题 -### Slack 机器人通知常见问题 - -1. Slack 未收到机器人告警通知 +1. Slack 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 +> 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md index 6730aa19dcb..df609e66b50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md @@ -5,22 +5,22 @@ sidebar_label: 告警 Telegram 机器人通知 keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 +> 阈值触发后发送告警信息，通过 Telegram 机器人通知到接收人。 -## 操作步骤 +## 操作步骤 -> 部署网络本身需支持科学上网，不支持设置代理 +> 部署网络本身需支持科学上网，不支持设置代理 ### 在 Telegram 创建机器人, 获取 Bot Token 和 UserId -1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` +1. 使用 [@BotFather](https://t.me/BotFather) 创建自己的机器人并获取访问令牌`Token` ![telegram-bot](/img/docs/help/telegram-bot-1.png) -2. 获取接收人的 `User ID` +2. 获取接收人的 `User ID` -**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, -访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` +**使用您要通知的接收人账户给刚创建 Bot 账户随便发送一个信息**, +访问 ```https://api.telegram.org/bot/getUpdates``` , **`使用上一步的 Bot Token 替换其中的`**, 响应`Json`数据中第一个`result.message.from.id` 值即为接收人的 `User ID` ```json { @@ -42,27 +42,26 @@ keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] } ``` -3. 记录保存我们获得的 `Token` 和 `User Id` +3. 记录保存我们获得的 `Token` 和 `User Id` -### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot +### 在 HertzBeat 新增告警通知人，通知方式为 Telegram Bot 1. **【告警通知】->【新增接收人】 ->【选择 Telegram 机器人通知方式】->【设置机器人Token和UserId】-> 【确定】** ![email](/img/docs/help/telegram-bot-2.png) -4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 -![email](/img/docs/help/alert-notice-policy.png) +![email](/img/docs/help/alert-notice-policy.png) +### Telegram 机器人通知常见问题 -### Telegram 机器人通知常见问题 - -1. Telegram 未收到机器人告警通知 +1. Telegram 未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 -> UserId 应为消息接收对象的UserId +> UserId 应为消息接收对象的UserId -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md index 401a3d04d45..a41ae531e28 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md @@ -3,6 +3,7 @@ id: alert_threshold title: 阈值告警配置 sidebar_label: 阈值告警配置 --- + > 对监控指标配置告警阈值(警告告警，严重告警，紧急告警)，系统根据阈值配置和采集指标数据计算触发告警。 ## 操作步骤 @@ -20,6 +21,7 @@ sidebar_label: 阈值告警配置 如上图所示，新增标签，这里我们设置标签为: linux:dev (开发环境使用Linux) #### 配置标签 + TODO 图片名称更新 ![threshold](/img/docs/help/alert-threshold-3.png) @@ -47,7 +49,6 @@ TODO 图片名称更新 - **恢复通知**：告警触发后是否发送恢复通知，默认不发送。 - **启用告警**：此告警阈值配置开启生效或关闭 - **阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。** **若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md index 5924d8965f8..37a9fb29d1b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md @@ -3,11 +3,11 @@ id: alert_threshold_expr title: 阈值触发表达式 sidebar_label: 阈值触发表达式 --- + > 在我们配置阈值告警时，需要配置阈值触发表达式，系统根据表达式和监控指标值计算触发是否告警，这里详细介绍下表达式使用。 #### 表达式支持的操作符 - | 运算符(可视化配置) | 运算符(表达式配置) | 支持类型 | 说明 | | | ------------------ | -------------------- | ----------------------- | ------------------------ | - | | 等于 | equals(str1,str2) | 字符型 | 判断字符串是否相等 | | @@ -27,22 +27,21 @@ sidebar_label: 阈值触发表达式 #### 表达式函数库列表 - -| 支持函数库 | 说明 | -| -------------------------------------------- | ------------------------------------------------------------------ | -| condition ? trueExpression : falseExpression | 三元运算符 | -| toDouble(str) | 将字符串转换为Double类型 | -| toBoolean(str) | 将字符串转换为Boolean类型 | -| toInteger(str) | 将字符串转换为Integer类型 | -| array[n] | 取数组第n个元素 | -| * | 算法乘 | -| / | 算法除 | -| % | 求余 | -| ( 和 ) | 括号用于控制运算的优先级，确保在逻辑或数学表达式中某些部分先被计算 | -| + | 加号用于表示数学中的加法运算、字符串拼接 | -| - | 减号用于表示数学中的减法运算 | -| && | 逻辑AND操作符 | -| \|\| | 逻辑OR操作符 | +| 支持函数库 | 说明 | +|----------------------------------------------|-----------------------------------| +| condition ? trueExpression : falseExpression | 三元运算符 | +| toDouble(str) | 将字符串转换为Double类型 | +| toBoolean(str) | 将字符串转换为Boolean类型 | +| toInteger(str) | 将字符串转换为Integer类型 | +| array[n] | 取数组第n个元素 | +| * | 算法乘 | +| / | 算法除 | +| % | 求余 | +| ( 和 ) | 括号用于控制运算的优先级，确保在逻辑或数学表达式中某些部分先被计算 | +| + | 加号用于表示数学中的加法运算、字符串拼接 | +| - | 减号用于表示数学中的减法运算 | +| && | 逻辑AND操作符 | +| \|\| | 逻辑OR操作符 | #### 支持的环境变量 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md index 61ed1dc99b5..022cd50f07e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md @@ -5,23 +5,24 @@ sidebar_label: 告警 Webhook 回调通知 keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 +> 阈值触发后发送告警信息，通过post请求方式调用WebHook接口通知到接收人。 -## 操作步骤 +## 操作步骤 -1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** +1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** ![email](/img/docs/help/alert-notice-5.png) -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) -### WebHook回调POST请求体BODY内容 +### WebHook回调POST请求体BODY内容 + +内容格式：JSON -内容格式：JSON ```json { "alarmId": 76456, @@ -43,22 +44,23 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 } ``` -| | | -|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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} | +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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通知常见问题 -### webhook通知常见问题 +1. WebHook回调未生效 -1. WebHook回调未生效 > 请查看告警中心是否已经产生此条告警信息 > 请排查配置的WebHook回调地址是否正确 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md index ce73c131d00..e0dbabf1a70 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md @@ -5,34 +5,34 @@ sidebar_label: 告警企业微信通知 keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系统] --- -> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 +> 阈值触发后发送告警信息，通过企业微信机器人通知到接收人。 -### 操作步骤 +### 操作步骤 -1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** +1. **【企业微信端】-> 【群设置】-> 【群机器人】-> 【添加新建机器人】-> 【设置机器人名称头像】-> 【添加成功后复制其WebHook地址】** -![email](/img/docs/help/alert-notice-6.jpg) +![email](/img/docs/help/alert-notice-6.jpg) -2. **【保存机器人的WebHook地址的KEY值】** +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` +> 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` -3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** +3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** ![email](/img/docs/help/alert-notice-7.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 -![email](/img/docs/help/alert-notice-4.png) +![email](/img/docs/help/alert-notice-4.png) +### 企业微信机器人通知常见问题 -### 企业微信机器人通知常见问题 +1. 企业微信群未收到机器人告警通知 -1. 企业微信群未收到机器人告警通知 > 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 +> 请排查是否配置正确机器人KEY，是否已配置告警策略关联 -其它问题可以通过交流群ISSUE反馈哦！ +其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md index 64f15c3777d..391005c080c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md @@ -4,114 +4,105 @@ title: 监控：AlmaLinux操作系统监控 sidebar_label: AlmaLinux操作系统 keywords: [开源监控系统, 开源操作系统监控, AlmaLinux操作系统监控] --- + > 对AlmaLinux操作系统的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- | ------------------------------------------------------------------------- | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -| 密钥 | 连接服务器所需密钥 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | ### 采集指标 #### 指标集合：系统基本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Host Name | 无 | 主机名称 | -| System Version | 无 | 操作系统版本 | -| Uptime | 无 | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | #### 指标集合：CPU 信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | --------------------------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | #### 指标集合：内存信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------- | -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：磁盘信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------- | -------- | ------------------ | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：网卡信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：文件系统 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | -------------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | #### 指标集合：Top10 CPU进程 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| cpu_usage | % | CPU占用率 | -| mem_usage | % | 内存占用率 | -| command | 无 | 执行命令 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | #### 指标集合：Top10 内存进程 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| mem_usage | % | 内存占用率 | -| cpu_usage | % | CPU占用率 | -| command | 无 | 执行命令 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md index 9b80fc35828..89f3cd701bc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md @@ -5,34 +5,33 @@ sidebar_label: HTTP API keywords: [开源监控系统, 开源网站监控, HTTP API监控] --- -> 调用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认证时使用的密码 | -| 请求Headers | HTTP 请求头 | -| 查询Params | HTTP查询参数,支持[时间表达式](time_expression) | -| Content-Type | 设置携带BODY请求体数据请求时的资源类型 | -| 请求BODY | 设置携带BODY请求体数据，PUT POST请求方式时有效 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------------|-------------------------------------------------------------------| +| 监控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认证时使用的密码 | +| 请求Headers | HTTP 请求头 | +| 查询Params | HTTP查询参数,支持[时间表达式](time_expression) | +| Content-Type | 设置携带BODY请求体数据请求时的资源类型 | +| 请求BODY | 设置携带BODY请求体数据，PUT POST请求方式时有效 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md index 03c514bc7b8..3d0654db3b5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md index 1c5adeeccc2..955c87b4e4f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md @@ -4,96 +4,93 @@ title: 监控：Clickhouse数据库监控 sidebar_label: Clickhouse数据库 keywords: [开源监控系统, 开源数据库监控, Clickhouse数据库监控] --- + > 对Clickhouse数据库的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------------------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为8123。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为8123。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：ping 可用性 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------ | -| responseTime | 无 | 响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | 无 | 响应时间 | #### 指标集合：system.metrics表的数据 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | -------------------------------------- | -| Query | 无 | 正在执行的查询的数量 | -| Merge | 无 | 正在执行的后台合并的数量 | -| Move | 无 | 正在执行的后台移动的数量 | -| PartMutation | 无 | 表变更的次数 | -| ReplicatedFetch | 无 | 从副本收集的数据块数量 | -| ReplicatedSend | 无 | 发送到副本的数量块数量 | -| ReplicatedChecks | 无 | 检查一致性的数据块数量 | -| QueryPreempted | 无 | 停止或等待的查询数量 | -| TCPConnection | 无 | TCP连接数量 | -| HTTPConnection | 无 | HTTP连接数量 | -| OpenFileForRead | 无 | 打开的可读文件的数量 | -| OpenFileForWrite | 无 | 打开的可写文件的数量 | -| QueryThread | 无 | 查询处理的线程数量 | -| ReadonlyReplica | 无 | 处于只读状态的 Replicated table 的数量 | -| EphemeralNode | 无 | ZooKeeper 中保存的临时节点数 | -| ZooKeeperWatch | 无 | ZooKeeper事件订阅数 | -| StorageBufferBytes | Bytes | Buffer tables 中的字节数 | -| VersionInteger | 无 | ClickHouse 版本号 | -| RWLockWaitingReaders | 无 | 等待读表的读写锁的线程数量 | -| RWLockWaitingWriters | 无 | 等待写表的读写锁的线程数量 | -| RWLockActiveReaders | 无 | 在一个表的读写锁中持有读锁的线程数 | -| RWLockActiveWriters | 无 | 在一个表的读写锁中持有写锁的线程数 | -| GlobalThread | 无 | 全局线程池中的线程数 | -| GlobalThreadActive | 无 | 全局线程池中活跃的线程数 | -| LocalThread | 无 | 本地线程池中的线程数 | -| LocalThreadActive | 无 | 本地线程池中活跃的线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|-------|------------------------------| +| Query | 无 | 正在执行的查询的数量 | +| Merge | 无 | 正在执行的后台合并的数量 | +| Move | 无 | 正在执行的后台移动的数量 | +| PartMutation | 无 | 表变更的次数 | +| ReplicatedFetch | 无 | 从副本收集的数据块数量 | +| ReplicatedSend | 无 | 发送到副本的数量块数量 | +| ReplicatedChecks | 无 | 检查一致性的数据块数量 | +| QueryPreempted | 无 | 停止或等待的查询数量 | +| TCPConnection | 无 | TCP连接数量 | +| HTTPConnection | 无 | HTTP连接数量 | +| OpenFileForRead | 无 | 打开的可读文件的数量 | +| OpenFileForWrite | 无 | 打开的可写文件的数量 | +| QueryThread | 无 | 查询处理的线程数量 | +| ReadonlyReplica | 无 | 处于只读状态的 Replicated table 的数量 | +| EphemeralNode | 无 | ZooKeeper 中保存的临时节点数 | +| ZooKeeperWatch | 无 | ZooKeeper事件订阅数 | +| StorageBufferBytes | Bytes | Buffer tables 中的字节数 | +| VersionInteger | 无 | ClickHouse 版本号 | +| RWLockWaitingReaders | 无 | 等待读表的读写锁的线程数量 | +| RWLockWaitingWriters | 无 | 等待写表的读写锁的线程数量 | +| RWLockActiveReaders | 无 | 在一个表的读写锁中持有读锁的线程数 | +| RWLockActiveWriters | 无 | 在一个表的读写锁中持有写锁的线程数 | +| GlobalThread | 无 | 全局线程池中的线程数 | +| GlobalThreadActive | 无 | 全局线程池中活跃的线程数 | +| LocalThread | 无 | 本地线程池中的线程数 | +| LocalThreadActive | 无 | 本地线程池中活跃的线程数 | #### 指标集合：system.events表的数据 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------------------------- |-------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------------|-------|------------------------------------------------------------------------------------------------| | Query | 无 | 要解释和可能执行的查询数量。 不包括由于 AST 大小限制、配额限制或同时运行的查询数量限制而无法解析或被拒绝的查询。 可能包括 ClickHouse 本身发起的内部查询。 不计算子查询。 | -| SelectQuery | 无 | 可能执行的 Select 查询数 | -| InsertQuery | 无 | 可能执行的 Insert 查询数 | -| InsertedRows | 无 | 被插入到所有表中的行数 | -| InsertedBytes | Bytes | 被插入到所有表中的字节数 | -| FailedQuery | 无 | 执行失败的查询数量 | -| FailedSelectQuery | 无 | 执行失败的 Select 查询数量 | -| FileOpen | 无 | 文件打开数 | -| MergeTreeDataWriterRows | 无 | 写入 MergeTree 表的数据行数 | -| MergeTreeDataWriterCompressedBytes | Bytes | 压缩写入 MergeTree 表的数据字节数 | +| SelectQuery | 无 | 可能执行的 Select 查询数 | +| InsertQuery | 无 | 可能执行的 Insert 查询数 | +| InsertedRows | 无 | 被插入到所有表中的行数 | +| InsertedBytes | Bytes | 被插入到所有表中的字节数 | +| FailedQuery | 无 | 执行失败的查询数量 | +| FailedSelectQuery | 无 | 执行失败的 Select 查询数量 | +| FileOpen | 无 | 文件打开数 | +| MergeTreeDataWriterRows | 无 | 写入 MergeTree 表的数据行数 | +| MergeTreeDataWriterCompressedBytes | Bytes | 压缩写入 MergeTree 表的数据字节数 | #### 指标集合：system.asynchronous_metrics表的数据 +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------------------|------|----------------------------------| +| AsynchronousMetricsCalculationTimeSpent | 无 | 异步指标计算花费的时间（秒） | +| jemalloc.arenas.all.muzzy_purged | 无 | 被清除的模糊（muzzy）页的数量 | +| jemalloc.arenas.all.dirty_purged | 无 | 被清除的脏 （dirty）页的数量 | +| BlockReadBytes_ram1 | 无 | ram1 块读取的字节数 | +| jemalloc.background_thread.run_intervals | 无 | jemalloc 后台线程的运行间隔数 | +| BlockQueueTime_nbd13 | 无 | nbd13 块队列等待时间 | +| jemalloc.background_thread.num_threads | 无 | jemalloc 后台线程的数量 | +| jemalloc.resident | 无 | jemalloc 分配器占用的物理内存大小（字节） | +| InterserverThreads | 无 | Interserver 线程数 | +| BlockWriteMerges_nbd7 | 无 | nbd7 块写合并数量 | +| MarkCacheBytes | 无 | StorageMergeTree 的 marks 的缓存大小 | +| MarkCacheFiles | 无 | StorageMergeTree 的 marks 的缓存文件数量 | +| MaxPartCountForPartition | 无 | partitions 中最大的活跃数据块的数量 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------------------------------- | ------ | ----------------------------------------- | -| AsynchronousMetricsCalculationTimeSpent | 无 | 异步指标计算花费的时间（秒） | -| jemalloc.arenas.all.muzzy_purged | 无 | 被清除的模糊（muzzy）页的数量 | -| jemalloc.arenas.all.dirty_purged | 无 | 被清除的脏 （dirty）页的数量 | -| BlockReadBytes_ram1 | 无 | ram1 块读取的字节数 | -| jemalloc.background_thread.run_intervals | 无 | jemalloc 后台线程的运行间隔数 | -| BlockQueueTime_nbd13 | 无 | nbd13 块队列等待时间 | -| jemalloc.background_thread.num_threads | 无 | jemalloc 后台线程的数量 | -| jemalloc.resident | 无 | jemalloc 分配器占用的物理内存大小（字节） | -| InterserverThreads | 无 | Interserver 线程数 | -| BlockWriteMerges_nbd7 | 无 | nbd7 块写合并数量 | -| MarkCacheBytes | 无 | StorageMergeTree 的 marks 的缓存大小 | -| MarkCacheFiles | 无 | StorageMergeTree 的 marks 的缓存文件数量 | -| MaxPartCountForPartition | 无 | partitions 中最大的活跃数据块的数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md index dcda89ee2b6..6b353bafd0b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md @@ -4,71 +4,67 @@ title: 监控：debian 系统监控 sidebar_label: Debian keywords: [开源监控系统, 操作系统监控, Debian监控] --- + > 对Debian系统的通用性能指标进行采集监控 ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- | ------------------------------------------------------------------------- | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Debian系统的ssh端口，默认: 22 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | -| 用户名 | 服务器用户名 | -| 密码 | 服务器密码 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -| 密钥 | 连接服务器所需密钥 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Debian系统的ssh端口，默认: 22 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | 服务器用户名 | +| 密码 | 服务器密码 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | ### 采集指标 #### 指标集合：系统基本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Host Name | 无 | 主机名称 | -| System Version | 无 | 操作系统版本 | -| Uptime | 无 | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | #### 指标集合：CPU 信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Info | 无 | 型号 | -| Cores | 无 | 核数 | -| Interrupt | 无 | 中断数 | -| Load | 无 | 负载 | -| Context Switch | 无 | 上下文切换 | -| Usage | % | 使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Info | 无 | 型号 | +| Cores | 无 | 核数 | +| Interrupt | 无 | 中断数 | +| Load | 无 | 负载 | +| Context Switch | 无 | 上下文切换 | +| Usage | % | 使用率 | #### 指标集合：内存信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------- | -------- | -------------- | -| Total Memory | Mb | 总内存容量 | -| User Program Memory | Mb | 用户程序内存量 | -| Free Memory | Mb | 空闲内存容量 | -| Buff Cache Memory | Mb | 缓存占用内存 | -| Available Memory | Mb | 剩余可用内存 | -| Memory Usage | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|---------| +| Total Memory | Mb | 总内存容量 | +| User Program Memory | Mb | 用户程序内存量 | +| Free Memory | Mb | 空闲内存容量 | +| Buff Cache Memory | Mb | 缓存占用内存 | +| Available Memory | Mb | 剩余可用内存 | +| Memory Usage | % | 内存使用率 | #### 指标集合：磁盘信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------- | -------- | ------------ | -| Disk Num | 无 | 磁盘总数 | -| Partition Num | 无 | 分区总数 | -| Block Write | 无 | 写磁盘块数 | -| Block Read | 无 | 读磁盘块数 | -| Write Rate | iops | 磁盘写速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|--------| +| Disk Num | 无 | 磁盘总数 | +| Partition Num | 无 | 分区总数 | +| Block Write | 无 | 写磁盘块数 | +| Block Read | 无 | 读磁盘块数 | +| Write Rate | iops | 磁盘写速率 | #### 指标集合：网卡信息 @@ -103,3 +99,4 @@ keywords: [开源监控系统, 操作系统监控, Debian监控] - 内存占用率：% - CPU占用率：% + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md index cdd9f6f6ee5..ea4a376c049 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md @@ -9,41 +9,41 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5236。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5236。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------------ | -| PORT_NUM | 无 | 数据库暴露服务端口 | -| CTL_PATH | 无 | 控制文件路径 | -| MAX_SESSIONS | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|-----------| +| PORT_NUM | 无 | 数据库暴露服务端口 | +| CTL_PATH | 无 | 控制文件路径 | +| MAX_SESSIONS | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------ | -| status$ | 无 | DM数据库的开闭状态 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|------------| +| status$ | 无 | DM数据库的开闭状态 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | ---------------------------------------------- | -| dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | -| dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | -| dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------------------------| +| dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | +| dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | +| dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md index 67ea72c177e..303ac47444f 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 @@ -13,24 +13,24 @@ keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | -|-----------|------------------------------------------------| -| DNS服务器IP | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：https://，http://）。 | -| 监控名称 | 标识此监控的名称，名称需要是唯一的。 | -| 端口 | DNS服务对外提供的端口，默认为53。 | -| 域名解析的地址 | 域名解析的地址。 | -| 连接超时时间 | 设置连接DNS服务器的超时时间，单位ms毫秒，默认6000毫秒。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------------------| +| DNS服务器IP | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：https://，http://）。 | +| 监控名称 | 标识此监控的名称，名称需要是唯一的。 | +| 端口 | DNS服务对外提供的端口，默认为53。 | +| 域名解析的地址 | 域名解析的地址。 | +| 连接超时时间 | 设置连接DNS服务器的超时时间，单位ms毫秒，默认6000毫秒。 | | 查询类别 | DNS查询的类别. 可选的值包括 `IN`， `CHAOS`， `HESIOD`， `NONE`， 和 `ANY`。默认值：IN | -| 是否使用tcp协议 | 设置DNS查询是否使用tcp协议。 | -| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒。 | -| 绑定标签 | 用于对监控资源进行分类管理。 | -| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息。 | +| 是否使用tcp协议 | 设置DNS查询是否使用tcp协议。 | +| 采集间隔 | 监控周期性数据采集的时间间隔，单位：秒，最小可设置为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 用于更多关于标识和描述此监控的信息，用户可以在此处添加备注信息。 | ### 采集指标 #### 指标集：Header -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|-----------------| | 响应时间 | 毫秒 | DNS服务器响应请求所需的时间 | | 操作码 | 无 | 当前消息的类型 | @@ -43,27 +43,31 @@ keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] ### 指标集: Question -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|-----------------------------------| | Section | 无 | 请求记录信息，其中包含查询的域名，资源类型，资源记录类，附加信息。 | ### 指标集: Answer -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|----------------------------------------| | Section0 | 无 | 请求响应信息，其中包含查询的域名，TTL，资源记录类，资源类型，查询的结果。 | + > Answer 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 ### 指标集: Authority -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|------------------------------------------------------------------| | Section0 | 无 | 域名的SOA（Start of Authority，权威区域起始）记录，其中包含查询的域名，TTL，资源类型，资源记录类等信息。 | + > Authority 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 ### 指标集: Additional -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|-------------| | Section0 | 无 | DNS查询的附加信息。 | + > Additional 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md index 221776b2426..c546b46fd2c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md @@ -7,7 +7,6 @@ keywords: [开源监控系统, 开源容器监控, Docker容器监控] > 对Docker容器的通用性能指标进行采集监控。 - ## 监控前操作 如果想要监控 `Docker` 中的容器信息，则需要按照一下步骤打开端口，让采集请求获取到对应的信息。 @@ -44,63 +43,60 @@ 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秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 系统时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------------------------------| +| 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容器中的更新时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| 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使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|--------------------| +| 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.5.x/help/doris_fe.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/doris_fe.md index 0e4803826be..10a66aa6853 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/doris_fe.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/doris_fe.md @@ -15,118 +15,118 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |-----------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8030 , 取值自 `http_port` 配置项的值 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8030 , 取值自 `http_port` 配置项的值 | | 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认6000毫秒 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 绑定标签 | 您可以使用标签进行监控资源的分类管理， 例如给资源分别绑定生产环境、测试环境的标签。 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 绑定标签 | 您可以使用标签进行监控资源的分类管理， 例如给资源分别绑定生产环境、测试环境的标签。 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：doris_fe_connection_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------- | -| value | 无 | 当前FE的MySQL端口连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 当前FE的MySQL端口连接数 | #### 指标集合：doris_fe_edit_log_clean 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| success | 无 | 清理历史元数据日志成功的次数 | -| failed | 无 | 清理历史元数据日志失败的次数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| success | 无 | 清理历史元数据日志成功的次数 | +| failed | 无 | 清理历史元数据日志失败的次数 | #### 指标集合：doris_fe_edit_log -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------- | -------- | ------------------------ | -| write | 无 | 元数据日志写入次数的计数 | -| read | 无 | 元数据日志读取次数的计数 | -| current | 无 | 元数据日志当前数量 | -| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | -| current_bytes | 字节 | 元数据日志当前值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|--------------| +| write | 无 | 元数据日志写入次数的计数 | +| read | 无 | 元数据日志读取次数的计数 | +| current | 无 | 元数据日志当前数量 | +| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | +| current_bytes | 字节 | 元数据日志当前值 | #### 指标集合：doris_fe_image_clean 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------- | -| success | 无 | 清理历史元数据镜像文件成功的次数 | -| failed | 无 | 清理历史元数据镜像文件失败的次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|------------------| +| success | 无 | 清理历史元数据镜像文件成功的次数 | +| failed | 无 | 清理历史元数据镜像文件失败的次数 | #### 指标集合：doris_fe_image_write 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| success | 无 | 生成元数据镜像文件成功的次数 | -| failed | 无 | 生成元数据镜像文件失败的次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| success | 无 | 生成元数据镜像文件成功的次数 | +| failed | 无 | 生成元数据镜像文件失败的次数 | #### 指标集合：doris_fe_query_err -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------- | -| value | 无 | 错误查询的累积值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------| +| value | 无 | 错误查询的累积值 | #### 指标集合：doris_fe_max_journal_id -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------------------------------------------------------------------------------------| +| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | #### 指标集合：doris_fe_max_tablet_compaction_score -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------------------------------------------------| +| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | #### 指标集合：doris_fe_qps -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------ | -| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | #### 指标集合：doris_fe_query_err_rate -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------- | -| value | 无 | 每秒错误查询数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------| +| value | 无 | 每秒错误查询数 | #### 指标集合：doris_fe_report_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------------------------------| +| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | #### 指标集合：doris_fe_rps -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------------------------- | -| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------| +| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | #### 指标集合：doris_fe_scheduled_tablet_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------------------------------------------------------| +| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | #### 指标集合：doris_fe_txn_status 可以观测各个状态下导入事务的数量，来判断是否有堆积 -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------- | -| unknown | 无 | 未知 | -| prepare | 无 | 准备中 | -| committed | 无 | 已提交 | -| visible | 无 | 可见 | -| aborted | 无 | 已中止/已撤销 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| unknown | 无 | 未知 | +| prepare | 无 | 准备中 | +| committed | 无 | 已提交 | +| visible | 无 | 可见 | +| aborted | 无 | 已中止/已撤销 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md index e3e143c17ed..8c2f1e290e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md @@ -7,15 +7,15 @@ keywords: [开源监控系统, 开源中间件监控, DynamicTp线程池监控] > 对DynamicTp actuator 暴露的线程池性能指标进行采集监控。 -### 前提 +### 前提 -1. 集成使用 `DynamicTp` +1. 集成使用 `DynamicTp` `DynamicTp` 是Jvm语言的基于配置中心的轻量级动态线程池，内置监控告警功能，可通过SPI自定义扩展实现。 -集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) +集成使用，请参考文档 [快速接入](https://dynamictp.cn/guide/use/quick-start.html) -2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 +2. 开启SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 ```yaml management: @@ -24,7 +24,8 @@ management: exposure: include: '*' ``` -测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: + +测试访问指标接口 `ip:port/actuator/dynamic-tp` 是否有响应json数据如下: ```json [ @@ -58,45 +59,44 @@ management: ] ``` -3. 在HertzBeat中间件监控下添加DynamicTp监控即可 - +3. 在HertzBeat中间件监控下添加DynamicTp监控即可 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口，默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | - | Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 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 | 无 | 等待超时任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|--------------------------| +| 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.5.x/help/elasticsearch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/elasticsearch.md index e64d956bc77..a0b3082cc1a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/elasticsearch.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/elasticsearch.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -27,7 +27,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] #### 指标集合：health -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------------|------|----------| | cluster_name | 无 | 集群名称 | | status | 无 | 集群状态 | @@ -41,7 +41,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] #### 指标集合：nodes -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|--------| | total | 无 | 节点数 | | successful | 无 | 在线节点数 | @@ -49,7 +49,7 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] #### 指标集合：nodes_detail -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------------|------|---------| | node_name | 无 | 节点名称 | | ip | 无 | IP地址 | @@ -61,3 +61,4 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] | disk_free | GB | 磁盘剩余容量 | | disk_total | GB | 磁盘总容量 | | disk_used_percent | % | 磁盘使用率 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md index 258f7bb36dd..6c894671cc6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 无 | CPU内核数量 | @@ -47,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|----------| | total | Mb | 总内存容量 | | used | Mb | 用户程序内存量 | @@ -58,7 +58,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：磁盘信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|-----------| | disk_num | 无 | 磁盘总数 | | partition_num | 无 | 分区总数 | @@ -68,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：网卡信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | interface_name | 无 | 网卡名称 | | receive_bytes | Mb | 入站数据流量 | @@ -76,7 +76,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -88,7 +88,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -99,9 +99,10 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md index ef260f4dc2c..177c41874fb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源 Flink 监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -26,7 +26,7 @@ keywords: [开源监控系统, 开源 Flink 监控] #### 指标集合：overview -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|----------| | slots_total | 个 | 插槽总数 | | slots_used | 个 | 已用插槽数 | @@ -34,5 +34,3 @@ keywords: [开源监控系统, 开源 Flink 监控] | jobs_running | 个 | 正在运行的任务数 | | jobs_failed | 个 | 已经失败的任务数 | - - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md index 53f7eceb7c3..01313bd7ae6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md @@ -7,10 +7,9 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 > 对FreeBSD操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。 - ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -29,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -37,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 核数 | CPU内核数量 | @@ -48,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|---------| | physmem | Mb | 物理内存 | | usermem | Mb | 用户程序内存量 | @@ -57,7 +56,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -69,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -80,7 +79,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md index c86dfb14a7b..d421b6a78eb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md @@ -11,7 +11,7 @@ keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|--------------------------------------| | 目标Host | 被监控的IPv4、IPv6。注意⚠️不包含协议头（例如：ftp://）。 | | 监控名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,8 @@ keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 #### 指标集合：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|------|------------------| | 活动状态 | 无 | 检查目录是否存在，且具有访问权限 | | 响应时间 | ms | 连接FTP响应时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md index f7fc4c150b7..9d39da7c9e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md @@ -7,29 +7,29 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] > 对网站的全部页面监测是否可用 > 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 -> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 +> 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 网站地图 | 网站SiteMap地图地址的相对路径，例如：/sitemap.xml。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 监控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 | 无 | 请求此网站反馈的错误信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|-----------------| +| url | 无 | 网页的URL路径 | +| statusCode | 无 | 请求此网页的响应HTTP状态码 | +| responseTime | ms毫秒 | 网站响应时间 | +| errorMsg | 无 | 请求此网站反馈的错误信息 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md index 40ad5765ca8..48dc239b69a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md @@ -1,30 +1,30 @@ --- id: guide title: 帮助中心 -sidebar_label: 帮助入门 +sidebar_label: 帮助入门 --- > 易用友好的实时监控工具，无需Agent，强大自定义监控能力。 -> 使用过程中的帮助文档,辅助信息。 +> 使用过程中的帮助文档,辅助信息。 ## 🔬 监控服务 > 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 > 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 -### 应用服务监控 +### 应用服务监控 -  👉 [网站监测](website)
-  👉 [HTTP API](api)
-  👉 [PING连通性](ping)
-  👉 [端口可用性](port)
-  👉 [全站监控](fullsite)
-  👉 [SSL证书有效期](ssl_cert)
-  👉 [JVM虚拟机](jvm)
-  👉 [SpringBoot2.0](springboot2)
-  👉 [DNS服务器](dns)
-  👉 [FTP服务器](ftp)
-  👉 [Websocket](websocket)
+ 👉 [网站监测](website)
+ 👉 [HTTP API](api)
+ 👉 [PING连通性](ping)
+ 👉 [端口可用性](port)
+ 👉 [全站监控](fullsite)
+ 👉 [SSL证书有效期](ssl_cert)
+ 👉 [JVM虚拟机](jvm)
+ 👉 [SpringBoot2.0](springboot2)
+ 👉 [DNS服务器](dns)
+ 👉 [FTP服务器](ftp)
+ 👉 [Websocket](websocket)
### 应用程序监控 @@ -34,92 +34,90 @@ sidebar_label: 帮助入门  👉 [SpringBoot3.0](springboot3)
 👉 [DynamicTp线程池](dynamic_tp)
+### 数据库监控 -### 数据库监控 - -  👉 [MYSQL数据库监控](mysql)
-  👉 [MariaDB数据库监控](mariadb)
-  👉 [PostgreSQL数据库监控](postgresql)
-  👉 [SqlServer数据库监控](sqlserver)
-  👉 [Oracle数据库监控](oracle)
-  👉 [达梦数据库监控](dm)
-  👉 [OpenGauss数据库监控](opengauss)
-  👉 [IoTDB数据库监控](iotdb)
-  👉 [TiDB数据库监控](tidb)
-  👉 [MongoDB数据库监控](mongodb)
-  👉 [NebulaGraph集群监控](nebulagraph_cluster)
+ 👉 [MYSQL数据库监控](mysql)
+ 👉 [MariaDB数据库监控](mariadb)
+ 👉 [PostgreSQL数据库监控](postgresql)
+ 👉 [SqlServer数据库监控](sqlserver)
+ 👉 [Oracle数据库监控](oracle)
+ 👉 [达梦数据库监控](dm)
+ 👉 [OpenGauss数据库监控](opengauss)
+ 👉 [IoTDB数据库监控](iotdb)
+ 👉 [TiDB数据库监控](tidb)
+ 👉 [MongoDB数据库监控](mongodb)
+ 👉 [NebulaGraph集群监控](nebulagraph_cluster)
### 缓存监控  👉 [Redis](redis)
 👉 [Memcached](memcached)
-### 操作系统监控 +### 操作系统监控 -  👉 [Linux操作系统监控](linux)
-  👉 [Windows操作系统监控](windows)
-  👉 [Ubuntu操作系统监控](ubuntu)
-  👉 [Centos操作系统监控](centos)
-  👉 [FreeBSD操作系统监控](freebsd)
-  👉 [RedHat操作系统监控](redhat)
-  👉 [RockyLinux操作系统监控](rockylinux)
-  👉 [EulerOS操作系统监控](euleros)
+ 👉 [Linux操作系统监控](linux)
+ 👉 [Windows操作系统监控](windows)
+ 👉 [Ubuntu操作系统监控](ubuntu)
+ 👉 [Centos操作系统监控](centos)
+ 👉 [FreeBSD操作系统监控](freebsd)
+ 👉 [RedHat操作系统监控](redhat)
+ 👉 [RockyLinux操作系统监控](rockylinux)
+ 👉 [EulerOS操作系统监控](euleros)
### 中间件监控 -  👉 [Zookeeper](zookeeper)
-  👉 [Kafka](kafka)
-  👉 [Tomcat](tomcat)
-  👉 [ShenYu](shenyu)
-  👉 [DynamicTp](dynamic_tp)
-  👉 [RabbitMQ](rabbitmq)
-  👉 [ActiveMQ](activemq)
-  👉 [Jetty](jetty)
-  👉 [Nacos](nacos)
+ 👉 [Zookeeper](zookeeper)
+ 👉 [Kafka](kafka)
+ 👉 [Tomcat](tomcat)
+ 👉 [ShenYu](shenyu)
+ 👉 [DynamicTp](dynamic_tp)
+ 👉 [RabbitMQ](rabbitmq)
+ 👉 [ActiveMQ](activemq)
+ 👉 [Jetty](jetty)
+ 👉 [Nacos](nacos)
### 云原生监控 -  👉 [Docker](docker)
-  👉 [Kubernetes](kubernetes)
+ 👉 [Docker](docker)
+ 👉 [Kubernetes](kubernetes)
### 大数据监控 -  👉 [Clickhouse](clickhouse)
-  👉 [ElasticSearch](elasticsearch)
-  👉 [Flink](flink)
+ 👉 [Clickhouse](clickhouse)
+ 👉 [ElasticSearch](elasticsearch)
+ 👉 [Flink](flink)
### Ai大模型监控  👉 [OpenAi](openai)
-### 网络监控 - -  👉 [华为通用交换机](huawei_switch)
+### 网络监控 + + 👉 [华为通用交换机](huawei_switch)
### 服务器监控 -## 💡 告警服务 +## 💡 告警服务 > 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 -> 告警服务的定位是阈值准确及时触发，告警通知及时可达。 +> 告警服务的定位是阈值准确及时触发，告警通知及时可达。 -### 告警中心 +### 告警中心 -> 已触发的告警信息中心，提供告警删除，告警处理，标记未处理，告警级别状态等查询过滤。 +> 已触发的告警信息中心，提供告警删除，告警处理，标记未处理，告警级别状态等查询过滤。 -### 告警配置 +### 告警配置 > 指标阈值配置，提供表达式形式的指标阈值配置，可设置告警级别，触发次数，告警通知模版和是否启用，关联监控等功能。 详见 👉 [阈值告警](alert_threshold)
-   👉 [阈值表达式](alert_threshold_expr) +   👉 [阈值表达式](alert_threshold_expr) -### 告警通知 +### 告警通知 > 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 > 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 -> 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。 - +> 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。  👉 [配置邮箱通知](alert_email)
 👉 [配置 Webhook 通知](alert_webhook)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md index fec361e2366..bda83b006e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md @@ -37,57 +37,54 @@ export HADOOP_OPTS= "$HADOOP_OPTS ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache (限JDK8及以下) -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md index f75d5cc8e98..e732bf45fd6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md @@ -4,6 +4,7 @@ title: 监控：Hbase Master监控 sidebar_label: Apache Hbase Master keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] --- + > 对Hbase Master的通用性能指标进行采集监控 **使用协议：HTTP** @@ -14,49 +15,46 @@ keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | -------------------------------------------------------------------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 端口 | hbase master的端口号，默认为16010。即:`hbase.master.info.port`参数值 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | hbase master的端口号，默认为16010。即:`hbase.master.info.port`参数值 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：server - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- |----| ---------------------------- | -| numRegionServers | 无 | 当前存活的 RegionServer 个数 | -| numDeadRegionServers | 无 | 当前Dead的 RegionServer 个数 | -| averageLoad | 无 | 集群平均负载 | -| clusterRequests | 无 | 集群请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|-------------------------| +| numRegionServers | 无 | 当前存活的 RegionServer 个数 | +| numDeadRegionServers | 无 | 当前Dead的 RegionServer 个数 | +| averageLoad | 无 | 集群平均负载 | +| clusterRequests | 无 | 集群请求数量 | #### 指标集合：Rit - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------- | ------ | ------------------- | -| ritCount | 无 | 当前的 RIT 数量 | -| ritCountOverThreshold | 无 | 超过阈值的 RIT 数量 | -| ritOldestAge | ms | 最老的RIT的持续时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|--------------| +| ritCount | 无 | 当前的 RIT 数量 | +| ritCountOverThreshold | 无 | 超过阈值的 RIT 数量 | +| ritOldestAge | ms | 最老的RIT的持续时间 | #### 指标集合：basic - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------------- | ----- | ------------------------ | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|--------------------| | liveRegionServers | 无 | 当前活跃RegionServer列表 | | deadRegionServers | 无 | 当前离线RegionServer列表 | -| zookeeperQuorum | 无 | Zookeeper列表 | -| masterHostName | 无 | Master节点 | -| BalancerCluster_num_ops | 无 | 集群负载均衡次数 | -| numActiveHandler | 无 | RPC句柄数 | -| receivedBytes | MB | 集群接收数据量 | -| sentBytes | MB | 集群发送数据量(MB) | -| clusterRequests | 无 | 集群总请求数量 | +| zookeeperQuorum | 无 | Zookeeper列表 | +| masterHostName | 无 | Master节点 | +| BalancerCluster_num_ops | 无 | 集群负载均衡次数 | +| numActiveHandler | 无 | RPC句柄数 | +| receivedBytes | MB | 集群接收数据量 | +| sentBytes | MB | 集群发送数据量(MB) | +| clusterRequests | 无 | 集群总请求数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md index 44d5b533932..1c1cfdf1802 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md @@ -4,6 +4,7 @@ title: 监控 Hbase RegionServer监控 sidebar_label: Apache Hbase RegionServer keywords: [开源监控系统, 开源数据库监控, RegionServer监控] --- + > 对Hbase RegionServer的通用性能指标进行采集监控 **使用协议：HTTP** @@ -14,16 +15,15 @@ keywords: [开源监控系统, 开源数据库监控, RegionServer监控] ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ |----------------------------------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 端口 | hbase regionserver的端口号，默认为16030。即:`hbase.regionserver.info.port`参数值 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | hbase regionserver的端口号，默认为16030。即:`hbase.regionserver.info.port`参数值 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 @@ -31,67 +31,64 @@ keywords: [开源监控系统, 开源数据库监控, RegionServer监控] #### 指标集合：server - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- |-------|------------------------------------------| -| regionCount | 无 | Region数量 | -| readRequestCount | 无 | 重启集群后的读请求数量 | -| writeRequestCount | 无 | 重启集群后的写请求数量 | -| averageRegionSize | MB | 平均Region大小 | -| totalRequestCount | 无 | 全部请求数量 | -| ScanTime_num_ops | 无 | Scan 请求总量 | -| Append_num_ops | 无 | Append 请求量 | -| Increment_num_ops | 无 | Increment请求量 | -| Get_num_ops | 无 | Get 请求量 | -| Delete_num_ops | 无 | Delete 请求量 | -| Put_num_ops | 无 | Put 请求量 | -| ScanTime_mean | 无 | 平均 Scan 请求时间 | -| ScanTime_min | 无 | 最小 Scan 请求时间 | -| ScanTime_max | 无 | 最大 Scan 请求时间 | -| ScanSize_mean | bytes | 平均 Scan 请求大小 | -| ScanSize_min | 无 | 最小 Scan 请求大小 | -| ScanSize_max | 无 | 最大 Scan 请求大小 | -| slowPutCount | 无 | 慢操作次数/Put | -| slowGetCount | 无 | 慢操作次数/Get | -| slowAppendCount | 无 | 慢操作次数/Append | -| slowIncrementCount | 无 | 慢操作次数/Increment | -| slowDeleteCount | 无 | 慢操作次数/Delete | -| blockCacheSize | 无 | 缓存块内存占用大小 | -| blockCacheCount | 无 | 缓存块数量_Block Cache 中的 Block 数量 | -| blockCacheExpressHitPercent | 无 | 读缓存命中率 | -| memStoreSize | 无 | Memstore 大小 | -| FlushTime_num_ops | 无 | RS写磁盘次数/Memstore flush 写磁盘次数 | -| flushQueueLength | 无 | Region Flush 队列长度 | -| flushedCellsSize | 无 | flush到磁盘大小 | -| storeFileCount | 无 | Storefile 个数 | -| storeCount | 无 | Store 个数 | -| storeFileSize | 无 | Storefile 大小 | -| compactionQueueLength | 无 | Compaction 队列长度 | -| percentFilesLocal | 无 | Region 的 HFile 位于本地 HDFS Data Node的比例 | -| percentFilesLocalSecondaryRegions | 无 | Region 副本的 HFile 位于本地 HDFS Data Node的比例 | -| hlogFileCount | 无 | WAL 文件数量 | -| hlogFileSize | 无 | WAL 文件大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------------------|-------|-----------------------------------------| +| regionCount | 无 | Region数量 | +| readRequestCount | 无 | 重启集群后的读请求数量 | +| writeRequestCount | 无 | 重启集群后的写请求数量 | +| averageRegionSize | MB | 平均Region大小 | +| totalRequestCount | 无 | 全部请求数量 | +| ScanTime_num_ops | 无 | Scan 请求总量 | +| Append_num_ops | 无 | Append 请求量 | +| Increment_num_ops | 无 | Increment请求量 | +| Get_num_ops | 无 | Get 请求量 | +| Delete_num_ops | 无 | Delete 请求量 | +| Put_num_ops | 无 | Put 请求量 | +| ScanTime_mean | 无 | 平均 Scan 请求时间 | +| ScanTime_min | 无 | 最小 Scan 请求时间 | +| ScanTime_max | 无 | 最大 Scan 请求时间 | +| ScanSize_mean | bytes | 平均 Scan 请求大小 | +| ScanSize_min | 无 | 最小 Scan 请求大小 | +| ScanSize_max | 无 | 最大 Scan 请求大小 | +| slowPutCount | 无 | 慢操作次数/Put | +| slowGetCount | 无 | 慢操作次数/Get | +| slowAppendCount | 无 | 慢操作次数/Append | +| slowIncrementCount | 无 | 慢操作次数/Increment | +| slowDeleteCount | 无 | 慢操作次数/Delete | +| blockCacheSize | 无 | 缓存块内存占用大小 | +| blockCacheCount | 无 | 缓存块数量_Block Cache 中的 Block 数量 | +| blockCacheExpressHitPercent | 无 | 读缓存命中率 | +| memStoreSize | 无 | Memstore 大小 | +| FlushTime_num_ops | 无 | RS写磁盘次数/Memstore flush 写磁盘次数 | +| flushQueueLength | 无 | Region Flush 队列长度 | +| flushedCellsSize | 无 | flush到磁盘大小 | +| storeFileCount | 无 | Storefile 个数 | +| storeCount | 无 | Store 个数 | +| storeFileSize | 无 | Storefile 大小 | +| compactionQueueLength | 无 | Compaction 队列长度 | +| percentFilesLocal | 无 | Region 的 HFile 位于本地 HDFS Data Node的比例 | +| percentFilesLocalSecondaryRegions | 无 | Region 副本的 HFile 位于本地 HDFS Data Node的比例 | +| hlogFileCount | 无 | WAL 文件数量 | +| hlogFileSize | 无 | WAL 文件大小 | #### 指标集合：IPC - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------- | ------ | ------------------- | -| numActiveHandler | 无 | 当前的 RIT 数量 | -| NotServingRegionException | 无 | 超过阈值的 RIT 数量 | -| RegionMovedException | ms | 最老的RIT的持续时间 | -| RegionTooBusyException | ms | 最老的RIT的持续时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|--------------| +| numActiveHandler | 无 | 当前的 RIT 数量 | +| NotServingRegionException | 无 | 超过阈值的 RIT 数量 | +| RegionMovedException | ms | 最老的RIT的持续时间 | +| RegionTooBusyException | ms | 最老的RIT的持续时间 | #### 指标集合：JVM - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------------- | ----- | ------------------------ | -| MemNonHeapUsedM | 无 | 当前活跃RegionServer列表 | -| MemNonHeapCommittedM | 无 | 当前离线RegionServer列表 | -| MemHeapUsedM | 无 | Zookeeper列表 | -| MemHeapCommittedM | 无 | Master节点 | -| MemHeapMaxM | 无 | 集群负载均衡次数 | -| MemMaxM | 无 | RPC句柄数 | -| GcCount | MB | 集群接收数据量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|--------------------| +| MemNonHeapUsedM | 无 | 当前活跃RegionServer列表 | +| MemNonHeapCommittedM | 无 | 当前离线RegionServer列表 | +| MemHeapUsedM | 无 | Zookeeper列表 | +| MemHeapCommittedM | 无 | Master节点 | +| MemHeapMaxM | 无 | 集群负载均衡次数 | +| MemMaxM | 无 | RPC句柄数 | +| GcCount | MB | 集群接收数据量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md index efb05494290..db494acbb8e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md @@ -15,42 +15,43 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS DataN ## 配置参数 -| 参数名称 | 参数帮助描述 | -| ---------------- |---------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | -| 端口 | Apache HDFS DataNode 的监控端口号，默认为50075。 | -| 查询超时时间 | 查询 Apache HDFS DataNode 的超时时间，单位毫秒，默认6000毫秒。 | -| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | -| 是否探测 | 新增监控前是否先探测检查监控可用性。 | -| 描述备注 | 此监控的更多描述和备注信息。 | +| 参数名称 | 参数帮助描述 | +|--------|----------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | +| 端口 | Apache HDFS DataNode 的监控端口号，默认为50075。 | +| 查询超时时间 | 查询 Apache HDFS DataNode 的超时时间，单位毫秒，默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | +| 是否探测 | 新增监控前是否先探测检查监控可用性。 | +| 描述备注 | 此监控的更多描述和备注信息。 | ### 采集指标 #### 指标集合：FSDatasetState -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------------- | -------- | ------------------------------------ | -| DfsUsed | GB | DataNode HDFS使用量 | -| Remaining | GB | DataNode HDFS剩余空间 | -| Capacity | GB | DataNode HDFS空间总量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|-------------------| +| DfsUsed | GB | DataNode HDFS使用量 | +| Remaining | GB | DataNode HDFS剩余空间 | +| Capacity | GB | DataNode HDFS空间总量 | #### 指标集合：JvmMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------ | -------- | ------------------------------------ | -| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | -| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | -| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | -| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | -| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | -| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | -| ThreadsRunnable | 个 | 处于 RUNNABLE 状态的线程数量 | -| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | -| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | -| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|-------------------------------| +| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | +| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | +| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | +| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | +| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | +| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | +| ThreadsRunnable | 个 | 处于 RUNNABLE 状态的线程数量 | +| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | +| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | #### 指标集合：runtime -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------| -------- | ----------------- | -| StartTime | | 启动时间 | \ No newline at end of file +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| StartTime | | 启动时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md index 26fd5e985af..66343c11cd2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md @@ -15,79 +15,79 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS NameN ## 配置参数 -| 参数名称 | 参数帮助描述 | -| ---------------- |---------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | -| 端口 | HDFS NameNode 的监控端口号，默认为50070。 | -| 查询超时时间 | 查询 HDFS NameNode 的超时时间，单位毫秒，默认6000毫秒。 | -| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | -| 是否探测 | 新增监控前是否先探测检查监控可用性。 | -| 描述备注 | 此监控的更多描述和备注信息。 | +| 参数名称 | 参数帮助描述 | +|--------|---------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | +| 端口 | HDFS NameNode 的监控端口号，默认为50070。 | +| 查询超时时间 | 查询 HDFS NameNode 的超时时间，单位毫秒，默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | +| 是否探测 | 新增监控前是否先探测检查监控可用性。 | +| 描述备注 | 此监控的更多描述和备注信息。 | ### 采集指标 #### 指标集合：FSNamesystem -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------------- | -------- | ------------------------------------ | -| CapacityTotal | | 集群存储总容量 | -| CapacityTotalGB | GB | 集群存储总容量 | -| CapacityUsed | | 集群存储已使用容量 | -| CapacityUsedGB | GB | 集群存储已使用容量 | -| CapacityRemaining | | 集群存储剩余容量 | -| CapacityRemainingGB | GB | 集群存储剩余容量 | -| CapacityUsedNonDFS | | 集群非 HDFS 使用容量 | -| TotalLoad | | 整个集群的客户端连接数 | -| FilesTotal | | 集群文件总数量 | -| BlocksTotal | | 总 BLOCK 数量 | -| PendingReplicationBlocks | | 等待被备份的块数量 | -| UnderReplicatedBlocks | | 副本数不够的块数量 | -| CorruptBlocks | | 坏块数量 | -| ScheduledReplicationBlocks | | 安排要备份的块数量 | -| PendingDeletionBlocks | | 等待被删除的块数量 | -| ExcessBlocks | | 多余的块数量 | -| PostponedMisreplicatedBlocks | | 被推迟处理的异常块数量 | -| NumLiveDataNodes | | 活的数据节点数量 | -| NumDeadDataNodes | | 已经标记为 Dead 状态的数据节点数量 | -| NumDecomLiveDataNodes | | 下线且 Live 的节点数量 | -| NumDecomDeadDataNodes | | 下线且 Dead 的节点数量 | -| NumDecommissioningDataNodes | | 正在下线的节点数量 | -| TransactionsSinceLastCheckpoint | | 从上次Checkpoint之后的事务数量 | -| LastCheckpointTime | | 上一次Checkpoint时间 | -| PendingDataNodeMessageCount | | DATANODE 的请求被 QUEUE 在 standby namenode 中的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|---------------------------------------------| +| CapacityTotal | | 集群存储总容量 | +| CapacityTotalGB | GB | 集群存储总容量 | +| CapacityUsed | | 集群存储已使用容量 | +| CapacityUsedGB | GB | 集群存储已使用容量 | +| CapacityRemaining | | 集群存储剩余容量 | +| CapacityRemainingGB | GB | 集群存储剩余容量 | +| CapacityUsedNonDFS | | 集群非 HDFS 使用容量 | +| TotalLoad | | 整个集群的客户端连接数 | +| FilesTotal | | 集群文件总数量 | +| BlocksTotal | | 总 BLOCK 数量 | +| PendingReplicationBlocks | | 等待被备份的块数量 | +| UnderReplicatedBlocks | | 副本数不够的块数量 | +| CorruptBlocks | | 坏块数量 | +| ScheduledReplicationBlocks | | 安排要备份的块数量 | +| PendingDeletionBlocks | | 等待被删除的块数量 | +| ExcessBlocks | | 多余的块数量 | +| PostponedMisreplicatedBlocks | | 被推迟处理的异常块数量 | +| NumLiveDataNodes | | 活的数据节点数量 | +| NumDeadDataNodes | | 已经标记为 Dead 状态的数据节点数量 | +| NumDecomLiveDataNodes | | 下线且 Live 的节点数量 | +| NumDecomDeadDataNodes | | 下线且 Dead 的节点数量 | +| NumDecommissioningDataNodes | | 正在下线的节点数量 | +| TransactionsSinceLastCheckpoint | | 从上次Checkpoint之后的事务数量 | +| LastCheckpointTime | | 上一次Checkpoint时间 | +| PendingDataNodeMessageCount | | DATANODE 的请求被 QUEUE 在 standby namenode 中的个数 | #### 指标集合：RPC -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------- | -------- | ---------------------- | -| ReceivedBytes | | 接收数据速率 | -| SentBytes | | 发送数据速率 | -| RpcQueueTimeNumOps | | RPC 调用速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|----------| +| ReceivedBytes | | 接收数据速率 | +| SentBytes | | 发送数据速率 | +| RpcQueueTimeNumOps | | RPC 调用速率 | #### 指标集合：runtime -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------| -------- | ----------------- | -| StartTime | | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| StartTime | | 启动时间 | #### 指标集合：JvmMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------ | -------- | ---------------- | -| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | -| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | -| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | -| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | -| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | -| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | -| GcCountParNew | 次 | 新生代GC消耗时间 | -| GcTimeMillisParNew | 毫秒 | 新生代GC消耗时间 | -| GcCountConcurrentMarkSweep | 毫秒 | 老年代GC次数 | -| GcTimeMillisConcurrentMarkSweep | 个 | 老年代GC消耗时间 | -| GcCount | 个 | GC次数 | -| GcTimeMillis | 个 | GC消耗时间 | -| ThreadsRunnable | 个 | 处于 BLOCKED 状态的线程数量 | -| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | -| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | -| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|-------------------------------| +| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | +| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | +| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | +| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | +| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | +| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | +| GcCountParNew | 次 | 新生代GC消耗时间 | +| GcTimeMillisParNew | 毫秒 | 新生代GC消耗时间 | +| GcCountConcurrentMarkSweep | 毫秒 | 老年代GC次数 | +| GcTimeMillisConcurrentMarkSweep | 个 | 老年代GC消耗时间 | +| GcCount | 个 | GC次数 | +| GcTimeMillis | 个 | GC消耗时间 | +| ThreadsRunnable | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | +| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md index 2c2136f91cf..3b41d3979c6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md @@ -16,6 +16,7 @@ keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hi ```shell hive --service metastore & ``` + **2. 启用 Hive Server2:** ```shell @@ -24,54 +25,53 @@ hive --service hiveserver2 & ### 配置参数 -| 参数名称 | 参数描述 | -| ---------- |--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 10002。 | -| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 参数名称 | 参数描述 | +|----------|--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 10002。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 #### 指标收集: 基本信息 -| 指标名称 | 指标单位 | 指标描述 | -|--------|-------|-----------------------------| -| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | -| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | -| 虚拟机版本 | 无 | 虚拟机的版本。 | -| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | +| 指标名称 | 指标单位 | 指标描述 | +|--------|------|-----------------------------| +| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机（VM）的名称。 | +| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | +| 虚拟机版本 | 无 | 虚拟机的版本。 | +| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | #### 指标收集: 环境信息 -| 指标名称 | 指标单位 | 指标描述 | -|------------|-------|--------------------------------| -| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | -| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | -| 操作系统版本 | 无 | 操作系统的版本。 | -| 操作系统架构 | 无 | 操作系统的架构。 | -| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | -| java运行环境版本 | 无 | Java 运行时环境的版本。 | +| 指标名称 | 指标单位 | 指标描述 | +|------------|------|--------------------------------| +| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | +| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | +| 操作系统版本 | 无 | 操作系统的版本。 | +| 操作系统架构 | 无 | 操作系统的架构。 | +| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | +| java运行环境版本 | 无 | Java 运行时环境的版本。 | #### 指标收集: 线程信息 -| 指标名称 | 指标单位 | 指标描述 | +| 指标名称 | 指标单位 | 指标描述 | |--------|------|------------------------------| | 线程数量 | None | HiveServer2 当前正在使用的线程数。 | -| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | +| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | | 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 | | 守护线程数 | None | HiveServer2 当前活动的守护线程数。 | #### 指标收集: 代码缓存 -| 指标名称 | 指标单位 | 指标描述 | -|------------|-------------|---------------| -| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | -| 内存池初始内存 | MB | 内存池请求的初始内存量。 | -| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | -| 内存池内存使用量 | MB | 内存池已使用内存量 | - +| 指标名称 | 指标单位 | 指标描述 | +|------------|------|---------------| +| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | +| 内存池初始内存 | MB | 内存池请求的初始内存量。 | +| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | +| 内存池内存使用量 | MB | 内存池已使用内存量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md index 9a4d4400c6c..6bd76f639e8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md @@ -11,7 +11,7 @@ keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------------------|-------------------------------------------------------------------------------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -25,8 +25,8 @@ keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] | SNMP privPassphrase | 用于SNMP v3，SNMP 加密密码 | | privPassword 加密方式 | 用于SNMP v3，SNMP 加密算法 | | 查询超时时间 | 设置查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 @@ -37,7 +37,7 @@ keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] #### 指标集合：huawei_core -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ifIndex | 无 | 接口索引 该值大于零且全局唯一。 | | ifDescr | 无 | 描述接口的字符串，应该包含制造商、产品名和接口软硬件的版本。 | @@ -47,7 +47,8 @@ keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] | ifInDiscards | 无 | 入方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文送往上层协议。 一个可能的原因是释放buffer的空间。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | | ifInErrors | 无 | 出错而不会被送往上层协议的报文/传输单元个数。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | | ifOutOctets | octets | 该接口出方向通过的总字节数，包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | -| ifOutDiscards | 无 | 出方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文发送。丢弃此类报文的一个可能原因是为了释放缓冲区空间。 在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | +| ifOutDiscards | 无 | 出方向的被丢弃的报文个数，即使没有错误发生。也将阻止这些报文发送。丢弃此类报文的一个可能原因是为了释放缓冲区空间。 在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内，该节点的值将出现不连续的情况。 | | ifOutErrors | 无 | 对于面向数据包的接口，该节点表示由于错误而无法发送的数据包数量。对于面向字符或固定长度接口，该节点表示由于错误而无法传输的传输单元的数量。这种计数器的值可能在管理系统的重新初始化时会不连续，其他时间如ifCounterDiscontinuityTime的值。 | | ifAdminStatus | 无 | 接口的理想状态。 testing（3）状态表示没有可操作的数据包通过。 当受管系统初始化时，全部接口开始于ifAdminStatus在down（2）状态。由于明确的管理动作或被管理的系统保留的每个配置信息，ifAdminStatus然后被更改为Up（1）或testing（3）状态（或保留在down（2）状态）。 | | ifOperStatus | 无 | 当前接口的操作状态。testing(3)状态表示没有可操作的数据包可以通过。如果ifAdminStatus是down(2)，则ifOperStatus应该是down（2）。 如果ifAdminStatus是改为up（1），则ifOperStatus应该更改为up（1）。如果接口准备好传输，接收网络流量; 它应该改为dormant(5)。如果接口正在等待外部动作（如串行线路等待传入连接）; 它应该保持在down(2)状态，并且只有当有故障阻止它变成up(1)状态。 它应该留在notPresent（6）状态如果接口缺少（通常为硬件）组件。 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md index 8770ababdcd..bb802791dda 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md @@ -4,6 +4,7 @@ title: 监控：HugeGraph监控 sidebar_label: Apache HugeGraph keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] --- + > 对HugeGraph的通用性能指标进行采集监控 **使用协议：HTTP** @@ -14,8 +15,7 @@ keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] ## 配置参数 - -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-----------|---------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 端口 | HugeGraph restserver的端口号，默认为8080。即:`restserver_port`参数值 | @@ -30,117 +30,112 @@ keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] #### 指标集合：gauges -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------------------ | -------- | --------------------------------- | -| edge-hugegraph-capacity | 无 | 表示当前图中边的容量上限 | -| edge-hugegraph-expire | 无 | 表示边数据的过期时间 | -| edge-hugegraph-hits | 无 | 表示边数据缓存的命中次数 | -| edge-hugegraph-miss | 无 | 表示边数据缓存的未命中次数 | -| edge-hugegraph-size | 无 | 表示当前图中边的数量 | -| instances | 无 | 表示当前运行的HugeGraph实例数量| -| schema-id-hugegraph-capacity | 无 | 表示图中schema ID的容量上限 | -| schema-id-hugegraph-expire | 无 | 表示schema ID数据的过期时间 | -| schema-id-hugegraph-hits | 无 | 表示schema ID数据缓存的命中次数| -| schema-id-hugegraph-miss | 无 | 表示schema ID数据缓存的未命中次数| -| schema-id-hugegraph-size | 无 | 表示当前图中schema ID的数量 | -| schema-name-hugegraph-capacity | 无 | 表示图中schema名称的容量上限 | -| schema-name-hugegraph-expire | 无 | 表示schema名称数据的过期时间 | -| schema-name-hugegraph-hits | 无 | 表示schema名称数据缓存的命中次数| -| schema-name-hugegraph-miss | 无 | 表示schema名称数据缓存的未命中次数| -| schema-name-hugegraph-size | 无 | 表示当前图中schema名称的数量 | -| token-hugegraph-capacity | 无 | 表示图中token的容量上限 | -| token-hugegraph-expire | 无 | 表示token数据的过期时间 | -| token-hugegraph-hits | 无 | 表示token数据缓存的命中次数 | -| token-hugegraph-miss | 无 | 表示token数据缓存的未命中次数 | -| token-hugegraph-size | 无 | 表示当前图中token的数量 | -| users-hugegraph-capacity | 无 | 表示图中用户的容量上限 | -| users-hugegraph-expire | 无 | 表示用户数据的过期时间 | -| users-hugegraph-hits | 无 | 表示用户数据缓存的命中次数 | -| users-hugegraph-miss | 无 | 表示用户数据缓存的未命中次数 | -| users-hugegraph-size | 无 | 表示当前图中用户的数量 | -| users_pwd-hugegraph-capacity | 无 | 表示users_pwd的容量上限 | -| users_pwd-hugegraph-expire | 无 | 表示users_pwd数据的过期时间 | -| users_pwd-hugegraph-hits | 无 | 表示users_pwd数据缓存的命中次数 | -| users_pwd-hugegraph-miss | 无 | 表示users_pwd数据缓存的未命中次数| -| users_pwd-hugegraph-size | 无 | 表示当前图中users_pwd的数量 | -| vertex-hugegraph-capacity | 无 | 表示图中顶点的容量上限 | -| vertex-hugegraph-expire | 无 | 表示顶点数据的过期时间 | -| vertex-hugegraph-hits | 无 | 表示顶点数据缓存的命中次数 | -| vertex-hugegraph-miss | 无 | 表示顶点数据缓存的未命中次数 | -| vertex-hugegraph-size | 无 | 表示当前图中顶点的数量 | -| batch-write-threads | 无 | 表示批量写入操作时的线程数 | -| max-write-threads | 无 | 表示最大写入操作的线程数 | -| pending-tasks | 无 | 表示待处理的任务数 | -| workers | 无 | 表示当前工作线程的数量 | -| average-load-penalty | 无 | 表示平均加载延迟 | -| estimated-size | 无 | 表示估计的数据大小 | -| eviction-count | 无 | 表示被驱逐的数据条数 | -| eviction-weight | 无 | 表示被驱逐数据的权重 | -| hit-count | 无 | 表示缓存命中总数 | -| hit-rate | 无 | 表示缓存命中率 | -| load-count | 无 | 表示数据加载次数 | -| load-failure-count | 无 | 表示数据加载失败次数 | -| load-failure-rate | 无 | 表示数据加载失败率 | -| load-success-count | 无 | 表示数据加载成功次数 | -| long-run-compilation-count | 无 | 表示长时间运行的编译次数 | -| miss-count | 无 | 表示缓存未命中总数 | -| miss-rate | 无 | 表示缓存未命中率 | -| request-count | 无 | 表示总的请求次数 | -| total-load-time | 无 | 表示总的数据加载时间 | -| sessions | 无 | 表示当前的活动会话数量 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-----------------------| +| edge-hugegraph-capacity | 无 | 表示当前图中边的容量上限 | +| edge-hugegraph-expire | 无 | 表示边数据的过期时间 | +| edge-hugegraph-hits | 无 | 表示边数据缓存的命中次数 | +| edge-hugegraph-miss | 无 | 表示边数据缓存的未命中次数 | +| edge-hugegraph-size | 无 | 表示当前图中边的数量 | +| instances | 无 | 表示当前运行的HugeGraph实例数量 | +| schema-id-hugegraph-capacity | 无 | 表示图中schema ID的容量上限 | +| schema-id-hugegraph-expire | 无 | 表示schema ID数据的过期时间 | +| schema-id-hugegraph-hits | 无 | 表示schema ID数据缓存的命中次数 | +| schema-id-hugegraph-miss | 无 | 表示schema ID数据缓存的未命中次数 | +| schema-id-hugegraph-size | 无 | 表示当前图中schema ID的数量 | +| schema-name-hugegraph-capacity | 无 | 表示图中schema名称的容量上限 | +| schema-name-hugegraph-expire | 无 | 表示schema名称数据的过期时间 | +| schema-name-hugegraph-hits | 无 | 表示schema名称数据缓存的命中次数 | +| schema-name-hugegraph-miss | 无 | 表示schema名称数据缓存的未命中次数 | +| schema-name-hugegraph-size | 无 | 表示当前图中schema名称的数量 | +| token-hugegraph-capacity | 无 | 表示图中token的容量上限 | +| token-hugegraph-expire | 无 | 表示token数据的过期时间 | +| token-hugegraph-hits | 无 | 表示token数据缓存的命中次数 | +| token-hugegraph-miss | 无 | 表示token数据缓存的未命中次数 | +| token-hugegraph-size | 无 | 表示当前图中token的数量 | +| users-hugegraph-capacity | 无 | 表示图中用户的容量上限 | +| users-hugegraph-expire | 无 | 表示用户数据的过期时间 | +| users-hugegraph-hits | 无 | 表示用户数据缓存的命中次数 | +| users-hugegraph-miss | 无 | 表示用户数据缓存的未命中次数 | +| users-hugegraph-size | 无 | 表示当前图中用户的数量 | +| users_pwd-hugegraph-capacity | 无 | 表示users_pwd的容量上限 | +| users_pwd-hugegraph-expire | 无 | 表示users_pwd数据的过期时间 | +| users_pwd-hugegraph-hits | 无 | 表示users_pwd数据缓存的命中次数 | +| users_pwd-hugegraph-miss | 无 | 表示users_pwd数据缓存的未命中次数 | +| users_pwd-hugegraph-size | 无 | 表示当前图中users_pwd的数量 | +| vertex-hugegraph-capacity | 无 | 表示图中顶点的容量上限 | +| vertex-hugegraph-expire | 无 | 表示顶点数据的过期时间 | +| vertex-hugegraph-hits | 无 | 表示顶点数据缓存的命中次数 | +| vertex-hugegraph-miss | 无 | 表示顶点数据缓存的未命中次数 | +| vertex-hugegraph-size | 无 | 表示当前图中顶点的数量 | +| batch-write-threads | 无 | 表示批量写入操作时的线程数 | +| max-write-threads | 无 | 表示最大写入操作的线程数 | +| pending-tasks | 无 | 表示待处理的任务数 | +| workers | 无 | 表示当前工作线程的数量 | +| average-load-penalty | 无 | 表示平均加载延迟 | +| estimated-size | 无 | 表示估计的数据大小 | +| eviction-count | 无 | 表示被驱逐的数据条数 | +| eviction-weight | 无 | 表示被驱逐数据的权重 | +| hit-count | 无 | 表示缓存命中总数 | +| hit-rate | 无 | 表示缓存命中率 | +| load-count | 无 | 表示数据加载次数 | +| load-failure-count | 无 | 表示数据加载失败次数 | +| load-failure-rate | 无 | 表示数据加载失败率 | +| load-success-count | 无 | 表示数据加载成功次数 | +| long-run-compilation-count | 无 | 表示长时间运行的编译次数 | +| miss-count | 无 | 表示缓存未命中总数 | +| miss-rate | 无 | 表示缓存未命中率 | +| request-count | 无 | 表示总的请求次数 | +| total-load-time | 无 | 表示总的数据加载时间 | +| sessions | 无 | 表示当前的活动会话数量 | #### 指标集合：counters - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------------------------------- | -------- | ---------------------------------------- | -| GET-SUCCESS_COUNTER | 无 | 记录GET请求成功的次数 | -| GET-TOTAL_COUNTER | 无 | 记录GET请求的总次数 | -| favicon-ico-GET-FAILED_COUNTER | 无 | 记录获取favicon.ico失败的GET请求次数 | -| favicon-ico-GET-TOTAL_COUNTER | 无 | 记录获取favicon.ico的GET请求总次数 | -| graphs-HEAD-FAILED_COUNTER | 无 | 记录graphs资源的HEAD请求失败的次数 | -| graphs-HEAD-SUCCESS_COUNTER | 无 | 记录graphs资源的HEAD请求成功的次数 | -| graphs-HEAD-TOTAL_COUNTER | 无 | 记录graphs资源的HEAD请求的总次数 | -| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求成功的次数 | -| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求的总次数 | -| metircs-GET-FAILED_COUNTER | 无 | 记录获取metrics失败的GET请求次数 | -| metircs-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | -| metrics-GET-SUCCESS_COUNTER | 无 | 记录获取metrics成功的GET请求次数 | -| metrics-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | -| metrics-gauges-GET-SUCCESS_COUNTER | 无 | 记录获取metrics gauges成功的GET请求次数 | -| metrics-gauges-GET-TOTAL_COUNTER | 无 | 记录获取metrics gauges的GET请求总次数 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------------------------------------|------|------------------------------| +| GET-SUCCESS_COUNTER | 无 | 记录GET请求成功的次数 | +| GET-TOTAL_COUNTER | 无 | 记录GET请求的总次数 | +| favicon-ico-GET-FAILED_COUNTER | 无 | 记录获取favicon.ico失败的GET请求次数 | +| favicon-ico-GET-TOTAL_COUNTER | 无 | 记录获取favicon.ico的GET请求总次数 | +| graphs-HEAD-FAILED_COUNTER | 无 | 记录graphs资源的HEAD请求失败的次数 | +| graphs-HEAD-SUCCESS_COUNTER | 无 | 记录graphs资源的HEAD请求成功的次数 | +| graphs-HEAD-TOTAL_COUNTER | 无 | 记录graphs资源的HEAD请求的总次数 | +| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求成功的次数 | +| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求的总次数 | +| metircs-GET-FAILED_COUNTER | 无 | 记录获取metrics失败的GET请求次数 | +| metircs-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | +| metrics-GET-SUCCESS_COUNTER | 无 | 记录获取metrics成功的GET请求次数 | +| metrics-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | +| metrics-gauges-GET-SUCCESS_COUNTER | 无 | 记录获取metrics gauges成功的GET请求次数 | +| metrics-gauges-GET-TOTAL_COUNTER | 无 | 记录获取metrics gauges的GET请求总次数 | #### 指标集合：system +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------------------|------|--------------------------------| +| mem | 无 | 表示系统的总内存量 | +| mem_total | 无 | 表示系统的总内存量（与mem相同） | +| mem_used | 无 | 表示系统当前使用的内存量 | +| mem_free | 无 | 表示系统空闲的内存量 | +| mem_unit | 无 | 表示内存量的单位（如字节、千字节、兆字节等） | +| processors | 无 | 表示系统的处理器数量 | +| uptime | 无 | 表示系统运行时间，即从启动到现在的时间 | +| systemload_average | 无 | 表示系统的平均负载，反映了系统的繁忙程度 | +| heap_committed | 无 | 表示JVM堆内存的承诺大小，即保证可供JVM使用的堆内存大小 | +| heap_init | 无 | 表示JVM堆内存的初始大小 | +| heap_used | 无 | 表示JVM当前使用的堆内存大小 | +| heap_max | 无 | 表示JVM堆内存的最大可使用大小 | +| nonheap_committed | 无 | 表示JVM非堆内存的承诺大小 | +| nonheap_init | 无 | 表示JVM非堆内存的初始大小 | +| nonheap_used | 无 | 表示JVM当前使用的非堆内存大小 | +| nonheap_max | 无 | 表示JVM非堆内存的最大可使用大小 | +| thread_peak | 无 | 表示自JVM启动以来峰值线程数 | +| thread_daemon | 无 | 表示当前活跃的守护线程数 | +| thread_total_started | 无 | 表示自JVM启动以来总共启动过的线程数 | +| thread_count | 无 | 表示当前活跃的线程数 | +| garbage_collector_g1_young_generation_count | 无 | 表示G1垃圾收集器年轻代垃圾收集的次数 | +| garbage_collector_g1_young_generation_time | 无 | 表示G1垃圾收集器年轻代垃圾收集的总时间 | +| garbage_collector_g1_old_generation_count | 无 | 表示G1垃圾收集器老年代垃圾收集的次数 | +| garbage_collector_g1_old_generation_time | 无 | 表示G1垃圾收集器老年代垃圾收集的总时间 | +| garbage_collector_time_unit | 无 | 表示垃圾收集时间的单位（如毫秒、秒等） | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------------------------------- | -------- | -------------------------------------------------- | -| mem | 无 | 表示系统的总内存量 | -| mem_total | 无 | 表示系统的总内存量（与mem相同） | -| mem_used | 无 | 表示系统当前使用的内存量 | -| mem_free | 无 | 表示系统空闲的内存量 | -| mem_unit | 无 | 表示内存量的单位（如字节、千字节、兆字节等） | -| processors | 无 | 表示系统的处理器数量 | -| uptime | 无 | 表示系统运行时间，即从启动到现在的时间 | -| systemload_average | 无 | 表示系统的平均负载，反映了系统的繁忙程度 | -| heap_committed | 无 | 表示JVM堆内存的承诺大小，即保证可供JVM使用的堆内存大小 | -| heap_init | 无 | 表示JVM堆内存的初始大小 | -| heap_used | 无 | 表示JVM当前使用的堆内存大小 | -| heap_max | 无 | 表示JVM堆内存的最大可使用大小 | -| nonheap_committed | 无 | 表示JVM非堆内存的承诺大小 | -| nonheap_init | 无 | 表示JVM非堆内存的初始大小 | -| nonheap_used | 无 | 表示JVM当前使用的非堆内存大小 | -| nonheap_max | 无 | 表示JVM非堆内存的最大可使用大小 | -| thread_peak | 无 | 表示自JVM启动以来峰值线程数 | -| thread_daemon | 无 | 表示当前活跃的守护线程数 | -| thread_total_started | 无 | 表示自JVM启动以来总共启动过的线程数 | -| thread_count | 无 | 表示当前活跃的线程数 | -| garbage_collector_g1_young_generation_count | 无 | 表示G1垃圾收集器年轻代垃圾收集的次数 | -| garbage_collector_g1_young_generation_time | 无 | 表示G1垃圾收集器年轻代垃圾收集的总时间 | -| garbage_collector_g1_old_generation_count | 无 | 表示G1垃圾收集器老年代垃圾收集的次数 | -| garbage_collector_g1_old_generation_time | 无 | 表示G1垃圾收集器老年代垃圾收集的总时间 | -| garbage_collector_time_unit | 无 | 表示垃圾收集时间的单位（如毫秒、秒等） | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md index 1881d79f4ee..00ff0b7f679 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md @@ -5,64 +5,62 @@ sidebar_label: InfluxDB 数据库 keywords: [开源监控系统, 开源数据库监控, InfluxDB 数据库监控] --- - ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为8086。 | -| URL | 数据库连接URL,一般是由host拼接，不需要添加 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为8086。 | +| URL | 数据库连接URL,一般是由host拼接，不需要添加 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：influxdb 基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | -|------------| ----------- |--------| -| build_date | 无 | 创建日期 | -| os | 无 | 操作系统 | -| cpus | 无 | cpus | -| version | 无 | 版本号 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|--------| +| build_date | 无 | 创建日期 | +| os | 无 | 操作系统 | +| cpus | 无 | cpus | +| version | 无 | 版本号 | #### 指标集合：http 响应时间 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|---------| | handler | 无 | handler | | path | 无 | 路径 | | response_code | 无 | 返回code | | method | 无 | 请求方法 | | user_agent | 无 | 用户代理 | -| status | 无 | 状态 | +| status | 无 | 状态 | #### 指标集合：正在排队的 TSM 数 -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------------------------------|------|------------| -| bucket | 无 | 存储桶 | -| engine | 无 | 引擎类型 | -| id | 无 | 标识符 | -| level | 无 | 级别 | -| path | 无 | 数据文件路径 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| bucket | 无 | 存储桶 | +| engine | 无 | 引擎类型 | +| id | 无 | 标识符 | +| level | 无 | 级别 | +| path | 无 | 数据文件路径 | #### 指标集合：HTTP写入请求的字节数量 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------| -| endpoint | 无 | 终点 | -| org_id | 无 | 组织标识符 | -| status | 无 | 状态 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| endpoint | 无 | 终点 | +| org_id | 无 | 组织标识符 | +| status | 无 | 状态 | #### 指标集合：质量控制请求总数 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------| -| result | 无 | 结果 | -| org | 无 | 组织标识符 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| result | 无 | 结果 | +| org | 无 | 组织标识符 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md index ac56245fee4..97469a71932 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合：basic_influxdb_memstats_alloc -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合： influxdb_database_numMeasurements -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | job | 无 | 指标名称 | | instance | 无 | 指标所属实例 | @@ -46,7 +46,7 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合： influxdb_query_rate_seconds -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | @@ -54,10 +54,9 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] #### 指标集合： influxdb_queryExecutor_queriesFinished_10s -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|---------| | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | | value | 无 | 指标值 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md index 0f0dc0e0ecb..fceb485f05b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md @@ -5,15 +5,15 @@ sidebar_label: IoTDB数据库 keywords: [开源监控系统, 开源数据库监控, IoTDB数据库监控] --- -> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 +> 对 Apache IoTDB 物联网时序数据库的运行状态（JVM相关），内存任务集群等相关指标进行监测。 -## 监控前操作 +## 监控前操作 -您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 +您需要在 IoTDB 开启`metrics`功能，他将提供 prometheus metrics 形式的接口数据。 -开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) +开启`metrics`功能, 参考 [官方文档](https://iotdb.apache.org/zh/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html) -主要如下步骤: +主要如下步骤: 1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server @@ -41,13 +41,13 @@ predefinedMetrics: - FILE ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 3. 在 HertzBeat 添加对应 IoTDB 监控即可。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -57,37 +57,37 @@ predefinedMetrics: | 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | | 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：cluster_node_status +#### 指标集合：cluster_node_status -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- |------|-------------------------| +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-------------------------| | name | 无 | 节点名称IP | | status | 无 | 节点状态，1=online 2=offline | #### 指标集合：jvm_memory_committed_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|------------------| | area | 无 | heap内存或nonheap内存 | | id | 无 | 内存区块 | -| value | MB | 当前向JVM申请的内存大小 | +| value | MB | 当前向JVM申请的内存大小 | #### 指标集合：jvm_memory_used_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| | area | 无 | heap内存或nonheap内存 | | id | 无 | 内存区块 | -| value | MB | JVM已使用内存大小 | +| value | MB | JVM已使用内存大小 | #### 指标集合：jvm_threads_states_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------| -| state | 无 | 线程状态 | -| count | 无 | 线程状态对应线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------| +| state | 无 | 线程状态 | +| count | 无 | 线程状态对应线程数量 | #### 指标集合：quantity 业务数据 @@ -99,22 +99,23 @@ predefinedMetrics: #### 指标集合：cache_hit 缓存 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------------------------------------------------| -| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | -| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------| +| name | 无 | 缓存名称 chunk/timeSeriesMeta/bloomFilter | +| value | % | chunk/timeSeriesMeta缓存命中率,bloomFilter拦截率 | #### 指标集合：queue 任务队列 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|---------------------------------------------------| -| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | -| status | 无 | 状态 running/waiting | -| value | 无 | 当前时间任务数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|----------------------------------------------| +| name | 无 | 队列名称 compaction_inner/compaction_cross/flush | +| status | 无 | 状态 running/waiting | +| value | 无 | 当前时间任务数 | #### 指标集合：thrift_connections -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-------------| -| name | 无 | 名称 | -| connection | 无 | thrift当前连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|-------------| +| name | 无 | 名称 | +| connection | 无 | thrift当前连接数 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md index b7414f878b1..745a4f70a88 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md @@ -1,59 +1,66 @@ --- id: issue title: 常见问题 -sidebar_label: 常见问题 +sidebar_label: 常见问题 --- -### 监控常见问题 +### 监控常见问题 -1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** -> 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http +1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** -2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK ** -> 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在) +> 如信息所示，输入的监控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是可用的。 + 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address 4. 配置了k8s监控，但是实际监控时间并未按照正确间隔时间执行 -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：首先查看hertzbeat的错误日志，如果出现了'desc: SQL statement too long, check maxSQLLength config'，信息 > 二：需要调整tdengine配置文件，可在服务器创建taos.cfg文件，调整# max length of an SQL : maxSQLLength 654800，然后重启tdengine，需要加入配置文件的挂载 -> 三：如果遇到了重启tdengine失败，需要调整挂载数据文件中的配置，见 .../taosdata/dnode/dnodeEps.json，中dnodeFqdn调整为启动失败的dockerId即可，然后docker restart tdengine +> 三：如果遇到了重启tdengine失败，需要调整挂载数据文件中的配置，见 .../taosdata/dnode/dnodeEps.json，中dnodeFqdn调整为启动失败的dockerId即可，然后docker restart tdengine 5. 配置http api监控，用于进行业务接口探测，确保业务可以用，另外接口有进行token鉴权校验，"Authorization：Bearer eyJhbGciOiJIUzI1...."，配置后测试，提示“StatusCode 401”。服务端应用收到的token为"Authorization：Bearer%20eyJhbGciOiJIUzI1....",hertzbeat对空格进行转义为“%20”，服务器没有转义导致鉴权失败，建议转义功能作为可选项。 - -### Docker部署常见问题 +### Docker部署常见问题 1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** -此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + > 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` +> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` 2. **按照流程部署，访问 http://ip:1157/ 无界面** -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 -3. **日志报错TDengine连接或插入SQL失败** +3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter ### 安装包部署常见问题 1. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md index 04a15823529..b60a5882b9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md @@ -15,17 +15,18 @@ keywords: [开源监控系统, 开源中间件监控, Jetty应用服务器监控 #### Jetty应用服务器开启JMX协议步骤 -[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) +[参考官方文档](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote) -1. 在 Jetty 启动 JMX 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 端口等参数。 +命令执行成功会创建出 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件 + +2. 编辑 `${JETTY_BASE}/start.d/jmx-remote.ini` 配置文件，修改 JMX 的 IP 端口等参数。 **`localhost` 需修改为对外暴露 IP** @@ -50,49 +51,45 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md index c97cc73b003..f046b3ef6a0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md @@ -28,57 +28,54 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache (限JDK8及以下) -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------| ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -|-----------------------| ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------------------------| ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md index 2b4ed0514b7..3cb4d74132c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md @@ -7,7 +7,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] > 对Kafka的通用性能指标进行采集监控 -**使用协议：JMX** +**使用协议：JMX** ### 监控前操作 @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` -在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 +在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell export JMX_PORT=9999; @@ -32,71 +32,65 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置Kafka连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：server_info -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Version | 无 | Kafka版本 | -| StartTimeMs | ms | 运行时间 | -| CommitId | 无 | 版本提交ID | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------| +| Version | 无 | Kafka版本 | +| StartTimeMs | ms | 运行时间 | +| CommitId | 无 | 版本提交ID | #### 指标集合：code_cache -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：active_controller_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 活跃监控器数量 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------| +| Value | 个 | 活跃监控器数量 | #### 指标集合：broker_partition_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 分区数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------| +| Value | 个 | 分区数量 | #### 指标集合：broker_leader_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| Value | 个 | 领导者数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------| +| Value | 个 | 领导者数量 | #### 指标集合：broker_handler_avg_percent 请求处理器空闲率 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| EventType | 无 | 类型 | -| RateUnit | 具体情况具体分析 | 单位 | -| Count | 个 | 数量 | -| OneMinuteRate | % | 一分钟处理率 | -| FiveMinuteRate | % | 五分钟处理率 | -| MeanRate | 无 | 平均处理率 | -| FifteenMinuteRate | 无 | 十五分钟处理率 | - - -> 其他指标见文知意，欢迎贡献一起优化文档。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|----------|---------| +| EventType | 无 | 类型 | +| RateUnit | 具体情况具体分析 | 单位 | +| Count | 个 | 数量 | +| OneMinuteRate | % | 一分钟处理率 | +| FiveMinuteRate | % | 五分钟处理率 | +| MeanRate | 无 | 平均处理率 | +| FifteenMinuteRate | 无 | 十五分钟处理率 | + +> 其他指标见文知意，欢迎贡献一起优化文档。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md index a0b0b625485..e0e5ecf7e50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md @@ -15,7 +15,7 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -34,7 +34,7 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL #### 指标集合：kafka_brokers -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | \_\_name__ | 无 | 指标名称 | | instance | 无 | 指标所属实例 | @@ -43,7 +43,7 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL #### 指标集合： kafka_topic_partitions -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | \_\_name__ | 无 | 指标名称 | | instance | 无 | 指标所属实例 | @@ -54,3 +54,4 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL 1. kafka启用了JMX监控，可以使用 [Kafka](kafka) 监控； 2. kafka集群部署kafka_exporter暴露的监控指标，可以参考 [Prometheus任务](prometheus) 配置Prometheus采集任务监控kafka。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md index f45da8d9b27..aa242d93a6b 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 @@ -7,14 +7,13 @@ keywords: [开源监控系统, 开源Kubernetes监控] > 对kubernetes的通用性能指标进行采集监控。 - ## 监控前操作 如果想要监控 `Kubernetes` 中的信息，则需要获取到可访问Api Server的授权TOKEN，让采集请求获取到对应的信息。 -参考获取token步骤 +参考获取token步骤 -#### 方式一: +#### 方式一: 1. 创建service account并绑定默认cluster-admin管理员集群角色 @@ -27,7 +26,9 @@ kubectl create clusterrolebinding dashboard-admin --clusterrole=cluster-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 @@ -36,13 +37,14 @@ kubectl create clusterrolebinding cluster-admin-manual --clusterrole=cluster-adm kubectl create token --duration=1000h cluster-admin ``` + ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| APiServer端口 | K8s APiServer端口，默认6443 | +| APiServer端口 | K8s APiServer端口，默认6443 | | token | 授权Access Token | | URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | | 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | @@ -53,44 +55,45 @@ kubectl create token --duration=1000h cluster-admin #### 指标集合：nodes -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- |--------| -| node_name | 无 | 节点名称 | -| is_ready | 无 | 节点状态 | -| capacity_cpu | 无 | CPU容量 | -| allocatable_cpu | 无 | 已分配CPU | -| capacity_memory | 无 | 内存容量 | -| allocatable_memory | 无 | 已分配内存 | -| creation_time | 无 | 节点创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------| +| node_name | 无 | 节点名称 | +| is_ready | 无 | 节点状态 | +| capacity_cpu | 无 | CPU容量 | +| allocatable_cpu | 无 | 已分配CPU | +| capacity_memory | 无 | 内存容量 | +| allocatable_memory | 无 | 已分配内存 | +| creation_time | 无 | 节点创建时间 | #### 指标集合：namespaces -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- |-------------| -| namespace | 无 | namespace名称 | -| status | 无 | 状态 | -| creation_time | 无 | 创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-------------| +| 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启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|----------------| +| 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 | 无 | 创建时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|--------------------------------------------------------| +| 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.5.x/help/linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md index 853be6610b4..4a69c04495e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md index 5fd59466717..2490e3630dd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md @@ -9,49 +9,46 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|------------| +| version | 无 | 数据库版本 | +| port | 无 | 数据库暴露服务端口 | +| datadir | 无 | 数据库存储数据盘地址 | +| max_connections | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| threads_created | 无 | MariaDB已经创建的总连接数 | -| threads_connected | 无 | MariaDB已经连接的连接数 | -| threads_cached | 无 | MariaDB当前缓存的连接数 | -| threads_running | 无 | MariaDB当前活跃的连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|------------------| +| 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 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|-------------------------| +| 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.5.x/help/memcached.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/memcached.md index 0debad01ce9..db88c1ac5fc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/memcached.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/memcached.md @@ -34,7 +34,7 @@ STAT version 1.4.15 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------|---------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不带协议头（例如：https://，http://） | | 监控名称 | 标识此监控的名称。名称需要唯一 | @@ -47,7 +47,7 @@ STAT version 1.4.15 #### 指标集：server_info -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------------|------|-------------------| | pid | 无 | Memcache 服务器进程 ID | | uptime | s | 服务器已运行的秒数 | @@ -65,3 +65,4 @@ STAT version 1.4.15 | cmd_flush | 无 | Flush 命令请求数 | | get_misses | 无 | Get 命令未命中次数 | | delete_misses | 无 | Delete 命令未命中次数 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md index 23c4a866809..8c54174b54a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -27,7 +27,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：构建信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------------|------|-------------------------| | version | 无 | MongoDB版本信息 | | gitVersion | 无 | 源代码git版本 | @@ -39,7 +39,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：服务器文档 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|--------| | deleted | 无 | 已删除数 | | inserted | 无 | 已插入数 | @@ -48,21 +48,21 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：服务器操作 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|-------------------| | scanAndOrder | 无 | 执行查询时需要扫描并进行排序的次数 | | writeConflicts | 无 | 写冲突的次数 | #### 指标集合： 服务器_ttl -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------------|------|-------------------------------| | deletedDocuments | 无 | 删除的过期文档数量 | | passes | 无 | TTL清理过程的总传递次数，每次传递会检查并删除过期的文档 | #### 指标集合：系统信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-----------------------| | currentTime | 无 | 当前时间 | | hostname | 无 | 主机名 | @@ -75,7 +75,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：操作系统信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|--------| | type | 无 | 操作系统类型 | | name | 无 | 操作系统名称 | @@ -83,7 +83,7 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] #### 指标集合：额外信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------|------|----------------------| | versionString | 无 | 版本 | | libcVersion | 无 | 标准库版本 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md index dc23f3d6fa5..c5deaab27a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md @@ -9,49 +9,46 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为3306。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为3306。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | 数据库版本 | -| port | 无 | 数据库暴露服务端口 | -| datadir | 无 | 数据库存储数据盘地址 | -| max_connections | 无 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|------------| +| version | 无 | 数据库版本 | +| port | 无 | 数据库暴露服务端口 | +| datadir | 无 | 数据库存储数据盘地址 | +| max_connections | 无 | 数据库最大连接数 | #### 指标集合：status -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| threads_created | 无 | MySql已经创建的总连接数 | -| threads_connected | 无 | MySql已经连接的连接数 | -| threads_cached | 无 | MySql当前缓存的连接数 | -| threads_running | 无 | MySql当前活跃的连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|----------------| +| 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 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|-------------------------| +| 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.5.x/help/nacos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nacos.md index 8b5313c2dc1..84b432f4651 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nacos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nacos.md @@ -7,87 +7,89 @@ keywords: [开源监控系统, 中间件监控, Nacos分布式监控] > 通过调用 Nacos Metrics 接口对 Nacos 注册配置中心服务的通用指标进行采集监控。 -### 监控前操作 +### 监控前操作 #### 搭建Nacos集群暴露metrics数据 1. 按照[部署文档](https://nacos.io/zh-cn/docs/deployment.html)搭建好Nacos集群。 2. 配置application.properties文件，暴露metrics数据。 + ``` management.endpoints.web.exposure.include=* ``` + 3. 访问```{ip}:8848/nacos/actuator/prometheus```，查看是否能访问到metrics数据。 更多信息请参考[Nacos 监控手册](https://nacos.io/zh-cn/docs/monitor-guide.html)。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 服务器Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Nacos服务端口 | Nacos服务对外提供的端口，默认为8848。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 服务器Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Nacos服务端口 | Nacos服务对外提供的端口，默认为8848。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：jvm -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| system_cpu_usage | 无 | CPU使用率 | -| system_load_average_1m | 无 | load | -| jvm_memory_used_bytes | 字节 | 内存使用字节，包含各种内存区 | -| jvm_memory_max_bytes | 字节 | 内存最大字节，包含各种内存区 | -| jvm_gc_pause_seconds_count | 无 | gc次数，包含各种gc | -| jvm_gc_pause_seconds_sum | 秒 | gc耗时，包含各种gc | -| jvm_threads_daemon | 无 | 线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------|------|----------------| +| system_cpu_usage | 无 | CPU使用率 | +| system_load_average_1m | 无 | load | +| jvm_memory_used_bytes | 字节 | 内存使用字节，包含各种内存区 | +| jvm_memory_max_bytes | 字节 | 内存最大字节，包含各种内存区 | +| jvm_gc_pause_seconds_count | 无 | gc次数，包含各种gc | +| jvm_gc_pause_seconds_sum | 秒 | gc耗时，包含各种gc | +| jvm_threads_daemon | 无 | 线程数 | #### 指标集合：Nacos -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| http_server_requests_seconds_count | 秒 | http请求次数，包括多种(url,方法,code) | -| http_server_requests_seconds_sum | 秒 | http请求总耗时，包括多种(url,方法,code) | -| nacos_timer_seconds_sum | 秒 | Nacos config水平通知耗时 | -| nacos_timer_seconds_count | 无 | Nacos config水平通知次数 | -| nacos_monitor{name='longPolling'} | 无 | Nacos config长连接数 | -| nacos_monitor{name='configCount'} | 无 | Nacos config配置个数 | -| nacos_monitor{name='dumpTask'} | 无 | Nacos config配置落盘任务堆积数 | -| nacos_monitor{name='notifyTask'} | 无 | Nacos config配置水平通知任务堆积数 | -| nacos_monitor{name='getConfig'} | 无 | Nacos config读配置统计数 | -| nacos_monitor{name='publish'} | 无 | Nacos config写配置统计数 | -| nacos_monitor{name='ipCount'} | 无 | Nacos naming ip个数 | -| nacos_monitor{name='domCount'} | 无 | Nacos naming域名个数(1.x 版本) | -| nacos_monitor{name='serviceCount'} | 无 | Nacos naming域名个数(2.x 版本) | -| nacos_monitor{name='failedPush'} | 无 | Nacos naming推送失败数 | -| nacos_monitor{name='avgPushCost'} | 秒 | Nacos naming平均推送耗时 | -| nacos_monitor{name='leaderStatus'} | 无 | Nacos naming角色状态 | -| nacos_monitor{name='maxPushCost'} | 秒 | Nacos naming最大推送耗时 | -| nacos_monitor{name='mysqlhealthCheck'} | 无 | Nacos naming mysql健康检查次数 | -| nacos_monitor{name='httpHealthCheck'} | 无 | Nacos naming http健康检查次数 | -| nacos_monitor{name='tcpHealthCheck'} | 无 | Nacos naming tcp健康检查次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------|------|-----------------------------| +| http_server_requests_seconds_count | 秒 | http请求次数，包括多种(url,方法,code) | +| http_server_requests_seconds_sum | 秒 | http请求总耗时，包括多种(url,方法,code) | +| nacos_timer_seconds_sum | 秒 | Nacos config水平通知耗时 | +| nacos_timer_seconds_count | 无 | Nacos config水平通知次数 | +| nacos_monitor{name='longPolling'} | 无 | Nacos config长连接数 | +| nacos_monitor{name='configCount'} | 无 | Nacos config配置个数 | +| nacos_monitor{name='dumpTask'} | 无 | Nacos config配置落盘任务堆积数 | +| nacos_monitor{name='notifyTask'} | 无 | Nacos config配置水平通知任务堆积数 | +| nacos_monitor{name='getConfig'} | 无 | Nacos config读配置统计数 | +| nacos_monitor{name='publish'} | 无 | Nacos config写配置统计数 | +| nacos_monitor{name='ipCount'} | 无 | Nacos naming ip个数 | +| nacos_monitor{name='domCount'} | 无 | Nacos naming域名个数(1.x 版本) | +| nacos_monitor{name='serviceCount'} | 无 | Nacos naming域名个数(2.x 版本) | +| nacos_monitor{name='failedPush'} | 无 | Nacos naming推送失败数 | +| nacos_monitor{name='avgPushCost'} | 秒 | Nacos naming平均推送耗时 | +| nacos_monitor{name='leaderStatus'} | 无 | Nacos naming角色状态 | +| nacos_monitor{name='maxPushCost'} | 秒 | Nacos naming最大推送耗时 | +| nacos_monitor{name='mysqlhealthCheck'} | 无 | Nacos naming mysql健康检查次数 | +| nacos_monitor{name='httpHealthCheck'} | 无 | Nacos naming http健康检查次数 | +| nacos_monitor{name='tcpHealthCheck'} | 无 | Nacos naming tcp健康检查次数 | #### 指标集合：Nacos 异常 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| nacos_exception_total{name='db'} | 无 | 数据库异常 | -| nacos_exception_total{name='configNotify'} | 无 | Nacos config水平通知失败 | -| nacos_exception_total{name='unhealth'} | 无 | Nacos config server之间健康检查异常 | -| nacos_exception_total{name='disk'} | 无 | Nacos naming写磁盘异常 | -| nacos_exception_total{name='leaderSendBeatFailed'} | 无 | Nacos naming leader发送心跳异常 | -| nacos_exception_total{name='illegalArgument'} | 无 | 请求参数不合法 | -| nacos_exception_total{name='nacos'} | 无 | Nacos请求响应内部错误异常（读写失败，没权限，参数错误） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------------------|------|--------------------------------| +| nacos_exception_total{name='db'} | 无 | 数据库异常 | +| nacos_exception_total{name='configNotify'} | 无 | Nacos config水平通知失败 | +| nacos_exception_total{name='unhealth'} | 无 | Nacos config server之间健康检查异常 | +| nacos_exception_total{name='disk'} | 无 | Nacos naming写磁盘异常 | +| nacos_exception_total{name='leaderSendBeatFailed'} | 无 | Nacos naming leader发送心跳异常 | +| nacos_exception_total{name='illegalArgument'} | 无 | 请求参数不合法 | +| nacos_exception_total{name='nacos'} | 无 | Nacos请求响应内部错误异常（读写失败，没权限，参数错误） | #### 指标集合：client -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| nacos_monitor{name='subServiceCount'} | 无 | 订阅的服务数 | -| nacos_monitor{name='pubServiceCount'} | 无 | 发布的服务数 | -| nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | -| nacos_client_request_seconds_count | 无 | 请求的次数，包括多种(url,方法,code) | -| nacos_client_request_seconds_sum | 秒 | 请求的总耗时，包括多种(url,方法,code) | - \ No newline at end of file +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------|------|--------------------------| +| nacos_monitor{name='subServiceCount'} | 无 | 订阅的服务数 | +| nacos_monitor{name='pubServiceCount'} | 无 | 发布的服务数 | +| nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | +| nacos_client_request_seconds_count | 无 | 请求的次数，包括多种(url,方法,code) | +| nacos_client_request_seconds_sum | 秒 | 请求的总耗时，包括多种(url,方法,code) | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md index d070101da8f..ded4a06ad2f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md @@ -14,7 +14,7 @@ keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGr nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 ``` -### +### **1、通过 stats 和 rocksdb stats 接口获取可用参数。** @@ -34,7 +34,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-------------|--------------------------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️没有协议头（例如：https://、http://） | | 监控名称 | 识别此监控的名称。名称需要唯一 | @@ -53,7 +53,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 指标太多，相关链接如下 **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------------------------------------------|------|--------| | 达到内存水位线的语句的数量(rate) | | | | 达到内存水位线的语句的数量(sum) | | | @@ -116,8 +116,9 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 指标太多，相关链接如下 **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------|------|------------------------| | rocksdb.backup.read.bytes | | 备份 RocksDB 数据库期间读取的字节数 | | rocksdb.backup.write.bytes | | 指标名称 | | ... | | ... | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md index 851f6dd7946..252f5f47d8a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md @@ -11,7 +11,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -27,7 +27,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：基础信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|---------| | responseTime | 无 | 响应时间 | | charset | 无 | 字符集 | @@ -35,21 +35,21 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Session -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------------|------|------------| | session | 无 | session的数量 | | running_query_count | 无 | 正在执行的查询的数量 | #### 指标集合：后台任务 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------------| | queue_jobs | 无 | 等待中的后台任务 | | running_jobs | 无 | 正在执行的后台任务的数量 | #### 指标集合：节点信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------------|------|-----------------| | total_storage_node | 无 | storage节点的数量 | | offline_storage_node | 无 | 离线的storage节点的数量 | @@ -60,7 +60,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Storage节点 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------------|------|---------------------| | host | 无 | 节点地址 | | port | 无 | 端口 | @@ -72,7 +72,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Meta节点 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|---------------------| | host | 无 | 节点地址 | | port | 无 | 端口 | @@ -81,7 +81,7 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, #### 指标集合：Graph节点 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|---------------------| | host | 无 | 节点地址 | | port | 无 | 端口 | @@ -89,3 +89,4 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, | version | 无 | 版本 | > 如果需要自定义监控模板采集NebulaGraph集群的数据，请参考： [NGQL自定义监控](../advanced/extend-ngql.md) + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md index a509ff7da2a..82908df358b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md @@ -13,18 +13,19 @@ keywords: [开源监控工具, 开源Java监控工具, 监控Nginx指标] 如果你想使用这种监控方式监控 'Nginx' 的信息，你需要修改你的 Nginx 配置文件以启用监控模块。 -### 启用 ngx_http_stub_status_module +### 启用 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 并解压，在目录下执行 +下载 Nginx 并解压，在目录下执行 ```shell ./configure --prefix=/usr/local/nginx --with-http_stub_status_module @@ -58,7 +59,7 @@ nginx -s reload 5. 在浏览器访问 `http://localhost/nginx-status` 即可查看 Nginx 监控状态信息。 -### 启用 `ngx_http_reqstat_module` +### 启用 `ngx_http_reqstat_module` 1. 安装 `ngx_http_reqstat_module` 模块 @@ -107,49 +108,47 @@ nginx -s reload 4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 - **参考文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** **⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** ### 配置参数 -| 参数名 | 参数描述 | -|-------------------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | Nginx 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | +| 参数名 | 参数描述 | +|--------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | Nginx 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | ### 收集指标 #### 指标收集：nginx_status -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------------|------------| -| 接收连接数 | | 已接受的连接 | -| 处理连接数 | | 成功处理的连接 | -| 活动连接数 | | 当前活动连接 | -| 丢弃连接数 | | 丢弃的连接 | -| 请求连接数 | | 客户端请求 | -| 读连接数 | | 正在执行读操作的连接 | -| 写连接数 | | 正在执行写操作的连接 | -| 等待连接数 | | 等待连接 | +| 指标名称 | 指标单位 | 指标描述 | +|-------|------|------------| +| 接收连接数 | | 已接受的连接 | +| 处理连接数 | | 成功处理的连接 | +| 活动连接数 | | 当前活动连接 | +| 丢弃连接数 | | 丢弃的连接 | +| 请求连接数 | | 客户端请求 | +| 读连接数 | | 正在执行读操作的连接 | +| 写连接数 | | 正在执行写操作的连接 | +| 等待连接数 | | 等待连接 | #### 指标集：req_status -| 指标名称 | 指标单位 | 指标描述 | -|---------|-------|---------| -| 分组类别 | | 分组类别 | -| 分组名称 | | 分组名称 | -| 最大并发连接数 | | 最大并发连接数 | -| 最大带宽 | kb | 最大带宽 | -| 总流量 | kb | 总流量 | -| 总请求数 | | 总请求数 | -| 当前并发连接数 | | 当前并发连接数 | -| 当前带宽 | kb | 当前带宽 | - +| 指标名称 | 指标单位 | 指标描述 | +|---------|------|---------| +| 分组类别 | | 分组类别 | +| 分组名称 | | 分组名称 | +| 最大并发连接数 | | 最大并发连接数 | +| 最大带宽 | kb | 最大带宽 | +| 总流量 | kb | 总流量 | +| 总请求数 | | 总请求数 | +| 当前并发连接数 | | 当前并发连接数 | +| 当前带宽 | kb | 当前带宽 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md index 5760321922f..735ab741b4d 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 @@ -15,7 +15,7 @@ NTP监控的中文文档如下： ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------|--------------------------------------------------| | 监控主机 | 被监控的IPv4、IPv6或域名。注意⚠️不包含协议头（例如：https://，http://） | | 监控名称 | 标识此监控的名称。名称需要是唯一的 | @@ -27,7 +27,7 @@ NTP监控的中文文档如下： #### 指标集：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|------|--------------------------| | 响应时间 | 毫秒 | NTP服务器响应请求所需的时间。 | | 时间 | 毫秒 | NTP服务器报告的当前时间。 | @@ -39,3 +39,4 @@ NTP监控的中文文档如下： | 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 | | 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | | 精度 | | NTP服务器时钟的精度，表示其准确性。 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md index d22b1238855..0af3ca3d17b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md @@ -8,12 +8,13 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] ### 准备工作 #### 获取会话密钥 -> 1. 打开 Chrome 浏览器的网络请求界面 + +> 1. 打开 Chrome 浏览器的网络请求界面 > `Mac: cmd + option + i` > `Windows: ctrl + shift + i` > 2. 访问 https://platform.openai.com/usage > 3. 找到 https://api.openai.com/dashboard/billing/usage 请求 -> 4. 找到请求头中 Authorization 字段，并复制 `Bearer ` 之后的内容。例如： `sess-123456` +> 4. 找到请求头中 Authorization 字段，并复制 `Bearer ` 之后的内容。例如： `sess-123456` ### 注意事项 @@ -22,11 +23,11 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -|:-------|---------------------------------| +| 参数名称 | 参数帮助描述 | +|:-------|---------------------------------|---| | 监控Host | 此处填写 api.openai.com 。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | | -| 会话密钥 | 即准备工作中获取的会话密钥。 | | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | | +| 会话密钥 | 即准备工作中获取的会话密钥。 | | | 采集器 | 配置此监控使用哪台采集器调度采集。 | | 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒。 | | 绑定标签 | 对监控资源的分类管理标签。 | @@ -36,7 +37,7 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] #### 指标集合：信用额度授予 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------|--------|---------| | 总授予额度 | 美元 ($) | 总授予额度 | | 总使用额度 | 美元 ($) | 总使用额度 | @@ -45,14 +46,14 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] #### 指标集合：模型花费 -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|--------|---------| -| 模型名称 | 无 | 模型名称 | -| 花费 | 美元 ($) | 花费 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|--------|--------| +| 模型名称 | 无 | 模型名称 | +| 花费 | 美元 ($) | 花费 | #### 指标集合：订阅计费 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|--------|--------------| | 是否有支付方式 | 无 | 是否有支付方式 | | 订阅是否已取消 | 无 | 订阅是否已取消 | @@ -80,3 +81,4 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] | 税务ID | 无 | 税务ID | | 结算地址 | 无 | 结算地址 | | 业务地址 | 无 | 业务地址 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md index 632a7f41b2d..8bf21d7debb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md @@ -9,50 +9,48 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| 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 | 无 | 这些统计信息上次被重置的时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | #### 指标集合：activity -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| running | 连接数 | 当前客户端连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md index 6c3b2e9ac7e..f32e2b070ae 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md @@ -4,114 +4,105 @@ title: 监控：OpenSUSE操作系统监控 sidebar_label: OpenSUSE操作系统 keywords: [开源监控系统, 开源操作系统监控, OpenSUSE操作系统监控] --- + > 对OpenSUSE操作系统的通用性能指标进行采集监控。 ### 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- |------------------------------------------------------| +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | | 端口 | Linux SSH对外提供的端口，默认为22。 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次获取信息都会创建一个连接 | -| 用户名 | SSH连接用户名，可选 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次获取信息都会创建一个连接 | +| 用户名 | SSH连接用户名，可选 | | 密码 | SSH连接密码，可选 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | | 密钥 | 连接服务器所需密钥 | ### 采集指标 #### 指标集合：系统基本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | ------------ | -| Host Name | 无 | 主机名称 | -| System Version | 无 | 操作系统版本 | -| Uptime | 无 | 启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | #### 指标集合：CPU 信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- | -------- | --------------------------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | CPU使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | #### 指标集合：内存信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------- | -| total | Mb | 总内存容量 | -| used | Mb | 用户程序内存量 | -| free | Mb | 空闲内存容量 | -| buff_cache | Mb | 缓存占用内存 | -| available | Mb | 剩余可用内存容量 | -| usage | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：磁盘信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------- | -------- | ------------------ | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：网卡信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------- |------|-------------| -| interface_name | 无 | 网卡名称 | -| receive_bytes | Mb | 入站数据流量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Mb | 入站数据流量 | | transmit_bytes | Mb | 出站数据流量 | #### 指标集合：文件系统 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | -------------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | #### 指标集合：Top10 CPU进程 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| cpu_usage | % | CPU占用率 | -| mem_usage | % | 内存占用率 | -| command | 无 | 执行命令 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | #### 指标集合：Top10 内存进程 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------ | -| pid | 无 | 进程ID | -| mem_usage | % | 内存占用率 | -| cpu_usage | % | CPU占用率 | -| command | 无 | 执行命令 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md index 49136e51c48..7ffdfa219ff 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md @@ -9,55 +9,56 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1521。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 数据库状态 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|---------| +| database_version | 无 | 数据库版本 | +| database_type | 无 | 数据库类型 | +| hostname | 无 | 主机名称 | +| instance_name | 无 | 数据库实例名称 | +| startup_time | 无 | 数据库启动时间 | +| status | 无 | 数据库状态 | #### 指标集合：tablespace -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| file_id | 无 | 文件ID | -| file_name | 无 | 文件名称 | -| tablespace_name | 无 | 所属表空间名称 | -| status | 无 | 状态 | -| bytes | MB | 大小 | -| blocks | 无 | 区块数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------| +| file_id | 无 | 文件ID | +| file_name | 无 | 文件名称 | +| tablespace_name | 无 | 所属表空间名称 | +| status | 无 | 状态 | +| bytes | MB | 大小 | +| blocks | 无 | 区块数量 | #### 指标集合：user_connect -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| username | 无 | 用户名 | -| counts | 个数 | 当前连接数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| 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 兆字节数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|------|---------------------------------------| +| qps | QPS | I/O Requests per Second 每秒IO请求数量 | +| tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 | +| mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md index 7b6613f25bd..401e86f9382 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md @@ -5,32 +5,33 @@ sidebar_label: PING连通性 keywords: [开源监控系统, 开源网络监控, 网络PING监控] --- -> 对对端HOST地址进行PING操作，判断其连通性 +> 对对端HOST地址进行PING操作，判断其连通性 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Ping超时时间 | 设置PING未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | - -### 常见问题 +### 常见问题 1. 安装包部署的hertzbeat下ping连通性监控异常 - 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 + > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md index e89f669886f..36a6bba9fe7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md @@ -1,10 +1,11 @@ --- id: plugin title: 自定义插件 -sidebar_label: 自定义插件 +sidebar_label: 自定义插件 --- ## 自定义插件 + ### 简介 当前`Hertzbeat`在使用时，主要依赖`alert`模块对用户进行通知，然后用户采取一些措施如发送请求、执行`sql`、执行`shell`脚本等。 @@ -13,13 +14,15 @@ sidebar_label: 自定义插件 目前，`HertzBeat`只在告警后设置了触发`alert`方法，如需在采集、启动程序等时机设置触发方法，请在`https://github.com/apache/hertzbeat/issues/new/choose` 提`Task`。 ### 具体使用 + 1. 拉取主分支代码 `git clone https://github.com/apache/hertzbeat.git` ，定位到`plugin`模块的 `Plugin`接口。 - ![plugin-1.png](/img/docs/help/plugin-1.png) + ![plugin-1.png](/img/docs/help/plugin-1.png) 2. 在`org.apache.hertzbeat.plugin.impl`目录下, 新建一个接口实现类，如`org.apache.hertzbeat.plugin.impl.DemoPluginImpl`,在实现类中接收`Alert`类作为参数，实现`alert`方法，逻辑由用户自定义，这里我们简单打印一下对象。 - ![plugin-2.png](/img/docs/help/plugin-2.png) + ![plugin-2.png](/img/docs/help/plugin-2.png) 3. 打包`hertzbeat-plugin`模块。 - ![plugin-3.png](/img/docs/help/plugin-3.png) + ![plugin-3.png](/img/docs/help/plugin-3.png) 4. 将打包后的`jar`包，拷贝到安装目录下的`ext-lib`目录下（若为`docker`安装则先将`ext-lib`目录挂载出来，再拷贝到该目录下） - ![plugin-4.png](/img/docs/help/plugin-4.png) + ![plugin-4.png](/img/docs/help/plugin-4.png) 5. 然后重启`HertzBeat`，即可实现自定义告警后处理策略。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md index 8d6c2eb5548..4c58cc4a308 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md @@ -24,26 +24,24 @@ keywords: [开源监控工具，开源Java监控工具，监控POP3指标] 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 ``` - ### 配置参数 -| 参数名 | 参数描述 | -|-------------------|-----------------------------------------------------| -| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | -| 监控名称 | 标识此监控的名称。名称需要唯一 | -| 端口 | POP3 提供的端口 | -| 超时时间 | 允许收集响应时间 | -| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | -| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | -| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | +| 参数名 | 参数描述 | +|--------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部（例如：https://，http://） | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | POP3 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间，单位为秒，最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后，添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | ### 采集指标 #### 指标集：email_status -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|------------| -| 邮件数量 | | 邮件数量 | -| 邮箱总大小 | kb | 邮箱中邮件的总大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------| +| 邮件数量 | | 邮件数量 | +| 邮箱总大小 | kb | 邮箱中邮件的总大小 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md index f27314e8e40..dd0b19aac82 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md @@ -9,22 +9,21 @@ keywords: [开源监控系统, 开源网络监控, TCP 端口可用性监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 连接超时时间 | 端口连接的等待超时时间，单位毫秒，默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md index 4716d0e2e64..59adae7da81 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md @@ -9,50 +9,48 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为5432。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口，默认为5432。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| server_version | 无 | 数据库服务器的版本号 | -| port | 无 | 数据库服务器端暴露服务端口 | -| server_encoding | 无 | 数据库服务器端的字符集编码 | -| data_directory | 无 | 数据库存储数据盘地址 | -| max_connections | 连接数 | 数据库最大连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------------| +| 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 | 无 | 这些统计信息上次被重置的时间 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------------------------------------------------------------| +| name | 无 | 数据库名称，或share-object为共享对象。 | +| conflicts | 次数 | 由于与恢复冲突而在这个数据库中被取消的查询的数目 | +| deadlocks | 个数 | 在这个数据库中被检测到的死锁数 | +| blks_read | 次数 | 在这个数据库中被读取的磁盘块的数量 | +| blks_hit | 次数 | 磁盘块被发现已经在缓冲区中的次数，这样不需要一次读取（这只包括 PostgreSQL 缓冲区中的命中，而不包括在操作系统文件系统缓冲区中的命中） | +| blk_read_time | ms | 在这个数据库中后端花费在读取数据文件块的时间 | +| blk_write_time | ms | 在这个数据库中后端花费在写数据文件块的时间 | +| stats_reset | 无 | 这些统计信息上次被重置的时间 | #### 指标集合：activity -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| running | 连接数 | 当前客户端连接数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| running | 连接数 | 当前客户端连接数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md index 91d7718e419..2eda0726d27 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md @@ -4,48 +4,46 @@ title: 监控：Linux 进程监控 sidebar_label: Process keywords: [开源监控系统, 操作系统进程监控, 进程监控] --- + > 对Linux系统进程基础信息进行采集监控，包括进程的 CPU使用率、内存使用率、物理内存、IO 等监控 ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| -------- | ------------------------------------------------------------------------- | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux系统的ssh端口，默认: 22 | -| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | -| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | -| 用户名 | 服务器用户名 | -| 密码 | 服务器密码 | -| 进程名称 | 需要监控的进程名称或进程部分名称 | -| 采集器 | 配置此监控使用哪台采集器调度采集 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -| 私钥 | 连接服务器所需私钥 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux系统的ssh端口，默认: 22 | +| 超时时间 | 设置连接的超时时间，单位ms毫秒，默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用，默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | 服务器用户名 | +| 密码 | 服务器密码 | +| 进程名称 | 需要监控的进程名称或进程部分名称 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 私钥 | 连接服务器所需私钥 | ### 采集指标 #### 指标集合：进程基本信息 - | 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------ | -| PID | 无 | 进程ID | -| User | 无 | 用户 | -| CPU | 无 | CPU使用率 | -| MEM | 无 | 内存使用率 | -| rss | 无 | 物理内存 | -| cmd | 无 | 运行命令 | +|------|------|--------| +| PID | 无 | 进程ID | +| User | 无 | 用户 | +| CPU | 无 | CPU使用率 | +| MEM | 无 | 内存使用率 | +| rss | 无 | 物理内存 | +| cmd | 无 | 运行命令 | #### 指标集合：内存使用信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------ | -| PID | 无 | 进程ID | -| detail | 无 | 详细监控指标 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| PID | 无 | 进程ID | +| detail | 无 | 详细监控指标 | 包含的指标： @@ -63,22 +61,20 @@ keywords: [开源监控系统, 操作系统进程监控, 进程监控] #### 指标集合：其他监控信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------ | -| PID | 无 | 进程ID | -| path | 无 | 执行路径 | -| date | 无 | 启动时间 | -| fd_count | 无 | 打开文件描述符数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-----------| +| PID | 无 | 进程ID | +| path | 无 | 执行路径 | +| date | 无 | 启动时间 | +| fd_count | 无 | 打开文件描述符数量 | #### 指标集合：IO - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------ | -| PID | 无 | 进程ID | -| metric | 无 | 监控指标名称 | -| value | 无 | 监控指标值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------| +| PID | 无 | 进程ID | +| metric | 无 | 监控指标名称 | +| value | 无 | 监控指标值 | 包含的指标： @@ -89,3 +85,4 @@ keywords: [开源监控系统, 操作系统进程监控, 进程监控] - read_bytes(进程从磁盘实际读取的字节数) - write_bytes(进程写入到磁盘的实际字节数) - cancelled_write_bytes(进程写入到磁盘的实际字节数) + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md index 50d148f72a9..571da45aac0 100755 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, Prometheus协议监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------------|------------------------------------------------------| | 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(例如: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -40,5 +40,3 @@ keywords: [ 开源监控系统, Prometheus协议监控 ] 其余设置保持默认。 - - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md index a59178686b3..1c12244997b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md @@ -4,52 +4,48 @@ title: 监控：Pulsar监控 sidebar_label: Apache Pulsar keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] --- + > 对Pulsar的通用性能指标进行采集监控 **使用协议：HTTP** ## 配置参数 - -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------------------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 端口 | Pulsar的webServiceProt值，默认为8080。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 绑定标签 | 用于对监控资源进行分类管理 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | Pulsar的webServiceProt值，默认为8080。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：版本信息 - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | ------------ | -| Version Info | 无 | 版本信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| Version Info | 无 | 版本信息 | #### 指标集合：process_start_time_seconds - -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- | ------------ | -| Process Start Time | 无 | 进程启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|--------| +| Process Start Time | 无 | 进程启动时间 | #### 指标集合：process_open_fds - -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------------------- | -------- | ---------------- | -| Open File Descriptors | 无 | 打开的文件描述符 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| Open File Descriptors | 无 | 打开的文件描述符 | #### 指标集合：process_max_fds - -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | -------------- | -| Max File Descriptors | 无 | 最大文件描述符 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|---------| +| Max File Descriptors | 无 | 最大文件描述符 | #### 指标集合： jvm_memory_pool_allocated_bytes diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md index 8cb91eeb3e6..89c728162c9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md @@ -5,42 +5,42 @@ sidebar_label: RabbitMQ消息中间件 keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间件监控] --- -> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 +> 对 RabbitMQ 消息中间件的运行状态，节点，队列等相关指标进行监测。 -### 监控前操作 +### 监控前操作 > HertzBeat 使用 RabbitMQ Management 的 Rest Api 对 RabbitMQ 进行指标数据采集。 -> 故需要您的 RabbitMQ 环境开启 Management 插件 +> 故需要您的 RabbitMQ 环境开启 Management 插件 -1. 开启 Management 插件，或使用自开启版本 +1. 开启 Management 插件，或使用自开启版本 ```shell rabbitmq-plugins enable rabbitmq_management ``` -2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 +2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -|----------|---------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | -| 用户名 | 接口Basic认证时使用的用户名 | -| 密码 | 接口Basic认证时使用的密码 | -| 超时时间 | HTTP请求查询超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | RabbitMQ Management 对外提供的HTTP端口，默认为15672。 | +| 用户名 | 接口Basic认证时使用的用户名 | +| 密码 | 接口Basic认证时使用的密码 | +| 超时时间 | HTTP请求查询超时时间 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：overview +#### 指标集合：overview -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------------|------|--------------------------| | product_version | 无 | 产品版本 | | product_name | 无 | 产品名称 | @@ -52,7 +52,7 @@ rabbitmq-plugins enable rabbitmq_management #### 指标集合：object_totals -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-----------------| | channels | 无 | channels的总数量 | | connections | 无 | connections的总数量 | @@ -62,65 +62,65 @@ rabbitmq-plugins enable rabbitmq_management #### 指标集合：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 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------|------|-------------------------------| +| 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. | +| 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. | +| 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 | +| vhost | 无 | vhost path | | auto_delete | 无 | Whether the queue will be deleted automatically when no longer used | -| policy | 无 | Effective policy name for the queue. | +| 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_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_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 | 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_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md index 5ceb911c8d3..e0b8ae48cf4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 无 | CPU内核数量 | @@ -47,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|----------| | total | Mb | 总内存容量 | | used | Mb | 用户程序内存量 | @@ -58,7 +58,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：磁盘信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|-----------| | disk_num | 无 | 磁盘总数 | | partition_num | 无 | 分区总数 | @@ -68,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：网卡信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | interface_name | 无 | 网卡名称 | | receive_bytes | Mb | 入站数据流量 | @@ -76,7 +76,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -88,7 +88,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -99,9 +99,10 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md index dd9b304e1ce..58248fb0b45 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md @@ -2,244 +2,239 @@ id: redis title: 监控：REDIS数据库监控 sidebar_label: REDIS数据库 -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] --- > 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|-----------------------------------------------| +| 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 | 无 | 客户端超时表中的客户端数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|--------------------------------------------------------------------------------| +| 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 | 无 | 已延迟释放的对象数。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|----------|-----------------------------------------------------------------------------------------------| +| 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操作期间写入时复制内存的字节大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|--------|-----------------------------------------------------------------------------------------------------| +| 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 | 无 | 正在写入的线程数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|----------------------------------------------------| +| 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的大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-------------------------------------------------------------------------------------| +| 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 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|------------------------| +| 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 | 无 | | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-----------| +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | #### 指标集合：cluster -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------------------| +| 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命令的统计信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------------------------------------------------------------------------------------------------------------------------| +| 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.5.x/help/rocketmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rocketmq.md index f12a43628ac..84cc24fc976 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rocketmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rocketmq.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |-----------|------------------------------------------------| | 注册中心Host | RocketMQ注册中心的IPV4,IPV6(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -24,7 +24,7 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 #### 指标集合：集群 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------------------|------|------------| | BrokerId | 无 | Broker唯一ID | | Address | 无 | Broker地址 | @@ -38,7 +38,7 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 #### 指标集合：消费者 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------------|------|--------| | Consumer_group | 无 | 消费者组 | | Client_quantity | 无 | 客户端数量 | @@ -46,3 +46,4 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 | Consume_type | 无 | 消费类型 | | Consume_tps | 无 | 消费TPS | | Delay | 无 | 延迟 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md index 0cf541702bc..55923468da8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -28,7 +28,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：系统基本信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | Host Name | 无 | 主机名称 | | System Version | 无 | 操作系统版本 | @@ -36,7 +36,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：CPU 信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------------------| | info | 无 | CPU型号 | | cores | 无 | CPU内核数量 | @@ -47,7 +47,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：内存信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|----------| | total | Mb | 总内存容量 | | used | Mb | 用户程序内存量 | @@ -58,7 +58,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：磁盘信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|-----------| | disk_num | 无 | 磁盘总数 | | partition_num | 无 | 分区总数 | @@ -68,7 +68,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：网卡信息 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |----------------|------|--------| | interface_name | 无 | 网卡名称 | | receive_bytes | Mb | 入站数据流量 | @@ -76,7 +76,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 #### 指标集合：文件系统 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------------|------|---------| | filesystem | 无 | 文件系统的名称 | | used | Mb | 已使用磁盘大小 | @@ -88,7 +88,7 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 统计进程使用CPU的Top10进程。统计信息包括：进程ID、CPU占用率、内存占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | cpu_usage | % | CPU占用率 | @@ -99,9 +99,10 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 统计进程使用内存的Top10进程。统计信息包括：进程ID、内存占用率、CPU占用率、执行命令。 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | pid | 无 | 进程ID | | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md index 08788efeaae..1149ed4bdd9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md @@ -5,24 +5,24 @@ sidebar_label: ShenYu网关监控 keywords: [开源监控系统, 开源消息中间件监控, ShenYu网关监控监控] --- -> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 +> 对 ShenYu 网关的运行状态（JVM相关），请求响应等相关指标进行监测。 -## 监控前操作 +## 监控前操作 -您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 +您需要在 ShenYu 网关开启`metrics`插件，暴露对应的 prometheus metrics 接口。 -开启插件, 参考 [官方文档](https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin) +开启插件, 参考 [官方文档](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} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` 2. 在网关的配置yaml文件中编辑如下内容： @@ -39,11 +39,11 @@ shenyu: jvm_enabled: true #开启jvm的监控指标 ``` -最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 +最后重启访问网关指标接口 `http://ip:8090` 响应 prometheus 格式数据即可。 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -53,79 +53,78 @@ shenyu: | 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | | 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：shenyu_request_total +#### 指标集合：shenyu_request_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-------------------| -| value | 无 | 收集ShenYu网关的所有请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | 收集ShenYu网关的所有请求数量 | #### 指标集合：shenyu_request_throw_created -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------------------| -| value | 无 | 收集ShenYu网关的异常请求数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | 收集ShenYu网关的异常请求数量 | #### 指标集合：process_cpu_seconds_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| value | 无 | 用户和系统CPU总计所用的秒数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 用户和系统CPU总计所用的秒数 | #### 指标集合：process_open_fds -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|--------------| -| value | 无 | 打开的文件描述符的数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------| +| value | 无 | 打开的文件描述符的数量 | #### 指标集合：process_max_fds -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------------| -| value | 无 | 打开的文件描述符的最大数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------| +| value | 无 | 打开的文件描述符的最大数量 | #### 指标集合：jvm_info -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-----------| -| runtime | 无 | JVM 版本信息 | -| vendor | 无 | JVM 版本信息 | -| version | 无 | JVM 版本信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------| +| runtime | 无 | JVM 版本信息 | +| vendor | 无 | JVM 版本信息 | +| version | 无 | JVM 版本信息 | #### 指标集合：jvm_memory_bytes_used -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| area | 无 | JVM 内存区域 | -| value | MB | 给定 JVM 内存区域的已用大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| area | 无 | JVM 内存区域 | +| value | MB | 给定 JVM 内存区域的已用大小 | #### 指标集合：jvm_memory_pool_bytes_used -| 指标名称 | 指标单位 | 指标帮助描述 | -|--------|------|-----------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已用大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的已用大小 | #### 指标集合：jvm_memory_pool_bytes_committed -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|------------------| -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的已提交大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的已提交大小 | #### 指标集合：jvm_memory_pool_bytes_max -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------| ----------- | -| pool | 无 | JVM 内存池 | -| value | MB | 给定 JVM 内存池的最大大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| pool | 无 | JVM 内存池 | +| value | MB | 给定 JVM 内存池的最大大小 | #### 指标集合：jvm_threads_state -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|-------------| -| state | 无 | 线程状态 | -| value | 无 | 对应线程状态的线程数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------| +| state | 无 | 线程状态 | +| value | 无 | 对应线程状态的线程数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md index 21dcd9a88f3..5755437e80e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md @@ -13,12 +13,11 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit > 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 - **协议使用：SMTP** ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |---------|---------------------------------------------------| | 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️无需协议头（例如：https://、http://） | | 监控名称 | 标识此监控的名称。名称需要保持唯一 | @@ -33,9 +32,10 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit #### 指标集：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |-------------|------|-------------------| | 响应时间 | 毫秒 | SMTP 服务器响应请求所需的时间 | | 响应状态 | | 响应状态 | | SMTP 服务器标语 | | SMTP 服务器的标语 | | helo 命令返回信息 | | helo 命令返回的响应信息 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md index 086e0a63ac8..a0695849705 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md @@ -19,6 +19,7 @@ keywords: [开源监控工具, 开源 Spring Gateway 监控工具, 监控 Spring spring-boot-starter-actuator ``` + **2. 修改 YML 配置以暴露度量接口:** ```yaml @@ -35,56 +36,55 @@ management: ### 配置参数 -| 参数名称 | 参数描述 | -| ----------- |--------------------------------------------------------| -| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | -| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | -| 端口 | 数据库提供的默认端口为 8080。 | +| 参数名称 | 参数描述 | +|----------|--------------------------------------------------------|-----------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头（例如：https://，http://）。 | +| 监控名称 | 用于标识此监控的名称，需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 8080。 | | 启用 HTTPS | 是否通过 HTTPS 访问网站，请注意⚠️当启用 HTTPS 时，需要将默认端口更改为 443 | -| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | -| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful -| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | +| 采集间隔 | 监控周期性采集数据的时间间隔，单位为秒，最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测，只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | ### 采集指标 #### 指标收集: 健康状态 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|--------------------------| -| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|-------------------------| +| 服务状态 | 无 | 服务健康状态: UP（正常），Down（异常） | #### 指标收集: 环境信息 -| 指标名称 | 指标单位 | 指标描述 | -|---------|-------|----------------------------------------------| -| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | -| 端口号 | 无 | 应用程序暴露的端口 | -| 操作系统 | 无 | 运行操作系统 | -| 操作系统架构 | 无 | 运行操作系统的架构 | -| JDK供应商 | 无 | JDK 供应商 | -| JVM版本 | 无 | JVM 版本 | +| 指标名称 | 指标单位 | 指标描述 | +|---------|------|----------------------------------------------| +| profile | 无 | 应用程序运行的配置环境: prod（生产环境），dev（开发环境），test（测试环境） | +| 端口号 | 无 | 应用程序暴露的端口 | +| 操作系统 | 无 | 运行操作系统 | +| 操作系统架构 | 无 | 运行操作系统的架构 | +| JDK供应商 | 无 | JDK 供应商 | +| JVM版本 | 无 | JVM 版本 | #### 指标收集: 线程信息 -| 指标名称 | 指标单位 | 指标描述 | -|-------------|------------|-------------| -| 状态 | 无 | 线程状态 | -| 数量 | 无 | 线程状态对应的线程数量 | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|-------------| +| 状态 | 无 | 线程状态 | +| 数量 | 无 | 线程状态对应的线程数量 | #### 指标收集: 内存使用情况 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|-------------| -| 内存空间 | 无 | 内存空间名称 | -| 内存占用 | MB | 此空间占用的内存大小 | +| 指标名称 | 指标单位 | 指标描述 | +|------|------|------------| +| 内存空间 | 无 | 内存空间名称 | +| 内存占用 | MB | 此空间占用的内存大小 | #### 指标收集: 路由信息 -| 指标名称 | 指标单位 | 指标描述 | -|-------|-------|----------| -| 路由id | 无 | 路由 ID | -| 匹配规则 | 无 | 路由匹配规则 | -| 资源标识符 | 无 | 服务资源标识符 | -| 优先级 | 无 | 此路由的优先级 | - +| 指标名称 | 指标单位 | 指标描述 | +|-------|------|---------| +| 路由id | 无 | 路由 ID | +| 匹配规则 | 无 | 路由匹配规则 | +| 资源标识符 | 无 | 服务资源标识符 | +| 优先级 | 无 | 此路由的优先级 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md index 280c6cb6b06..e66d4237a13 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md @@ -7,7 +7,6 @@ keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控 > 对SpringBoot2.0 actuator 暴露的通用性能指标进行采集监控。 - ## 监控前操作 如果想要通过此监控类型监控 `SpringBoot` 中的信息，则需要您的SpringBoot应用集成并开启SpringBoot Actuator。 @@ -20,6 +19,7 @@ keywords: [开源监控系统, 开源消息中间件监控, SpringBoot2.0 监控 spring-boot-starter-actuator ``` + **2、修改YML配置暴露指标接口：** ```yaml @@ -30,7 +30,9 @@ management: include: '*' enabled-by-default: on ``` + *注意：如果你的项目里还引入了认证相关的依赖，比如springboot-security,那么SpringBoot Actuator暴露出的接口可能会被拦截，此时需要你手动放开这些接口，以springboot-security为例，需要在SecurityConfig配置类中加入以下代码：* + ```java public class SecurityConfig extends WebSecurityConfigurerAdapter{ @Override @@ -46,48 +48,50 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ } } ``` + ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ |------------------------------------------------------| -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 应用服务对外提供的端口，默认为8080。 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口，默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | | Base Path | 暴露接口路径前缀，默认 /actuator | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------ | -------- |--------------------------------| -| status | 无 | 服务健康状态: UP,Down | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-----------------| +| status | 无 | 服务健康状态: UP,Down | #### 指标集合：environment -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------| -------- |----------------------------| -| profile | 无 | 应用运行profile: prod,dev,test | -| port | 无 | 应用暴露端口 | -| os | 无 | 运行所在操作系统 | -| os_arch | 无 | 运行所在操作系统架构 | -| jdk_vendor | 无 | jdk vendor | -| jvm_version | 无 | jvm version | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|----------------------------| +| profile | 无 | 应用运行profile: prod,dev,test | +| port | 无 | 应用暴露端口 | +| os | 无 | 运行所在操作系统 | +| os_arch | 无 | 运行所在操作系统架构 | +| jdk_vendor | 无 | jdk vendor | +| jvm_version | 无 | jvm version | #### 指标集合：threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------------- |------|--------------------| -| state | 无 | 线程状态 | -| number | 无 | 此线程状态对应的线程数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|--------------| +| state | 无 | 线程状态 | +| number | 无 | 此线程状态对应的线程数量 | #### 指标集合：memory_used -| 指标名称 | 指标单位 | 指标帮助描述 | -|---------|------|------------| -| space | 无 | 内存空间名称 | -| mem_used | MB | 此空间占用内存大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-----------| +| space | 无 | 内存空间名称 | +| mem_used | MB | 此空间占用内存大小 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md index 384f9249d16..56a63068b17 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md @@ -51,7 +51,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -65,23 +65,28 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### 采集指标 #### 指标集合：可用性 -| 指标名称 | 指标单位 | 指标帮助描述 | + +| 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms | 响应时间 | #### 指标集合：线程 -| 指标名称 | 指标单位 | 指标帮助描述 | -|-------|------|--------------------| -| state | 无 | 线程状态 | -| size | 无 | 此线程状态对应的线程数量 | + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------| +| state | 无 | 线程状态 | +| size | 无 | 此线程状态对应的线程数量 | #### 指标集合：内存使用 -| 指标名称 | 指标单位 | 指标帮助描述 | + +| 指标名称 | 指标单位 | 指标帮助描述 | |----------|------|-----------| | space | 无 | 内存空间名称 | | mem_used | MB | 此空间占用内存大小 | #### 指标集合：健康状态 -| 指标名称 | 指标单位 | 指标帮助描述 | + +| 指标名称 | 指标单位 | 指标帮助描述 | |--------|------|-----------------| -| status | 无 | 服务健康状态: UP,Down | \ No newline at end of file +| status | 无 | 服务健康状态: UP,Down | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md index 5dc66e27cfc..22a5a50ddd8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md @@ -9,68 +9,68 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 数据库对外提供的端口，默认为1433。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| URL | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 数据库启动时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------------------------------------------------| +| 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, 缓存池中每秒写的页数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------|------|-------------------------------------------------------------------------------------| +| 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 | 无 | 已连接的会话数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|---------| +| user_connection | 无 | 已连接的会话数 | -### 常见问题 +### 常见问题 -1. SSL连接问题修复 +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端返回的任何根证书。 +添加`SqlServer`监控时使用高级设置，自定义JDBC URL，拼接的jdbc url后面加上参数配置，```;encrypt=true;trustServerCertificate=true;```这个参数true表示无条件信任server端返回的任何根证书。 -样例：```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` +样例：```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) +参考文档：[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.5.x/help/ssl_cert.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md index ce0084f7e95..73957e31fb8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md @@ -5,29 +5,30 @@ sidebar_label: SSL证书监控 keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] --- -> 对网站的SSL证书过期时间，响应时间等指标进行监测 +> 对网站的SSL证书过期时间，响应时间等指标进行监测 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，https一般默认为443。 | +| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：certificate +#### 指标集合：certificate + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|----------| +| subject | 无 | 证书名称 | +| expired | 无 | 是否过期 | +| start_time | 无 | 有效期开始时间 | +| start_timestamp | ms毫秒 | 有效期开始时间戳 | +| end_time | 无 | 过期时间 | +| end_timestamp | ms毫秒 | 过期时间戳 | -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- |------|----------| -| 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.5.x/help/tidb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tidb.md index bc5db826027..fe5eef718ef 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tidb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tidb.md @@ -9,21 +9,21 @@ keywords: [开源监控系统, 开源数据库监控, TiDB数据库监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| Service端口 | TiDB数据库对外提供用于状态报告的端口，默认为10080。 | -| PD端口 | TiDB数据库的PD端口，默认为2379。 | -| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | -| JDBC端口 | TiDB数据库对外提供用于客户端请求的端口，默认为4000。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| JDBC URL | 数据库使用[JDBC驱动的](https://docs.pingcap.com/zh/tidb/stable/dev-guide-connect-to-tidb#jdbc)连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------------------------------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| Service端口 | TiDB数据库对外提供用于状态报告的端口，默认为10080。 | +| PD端口 | TiDB数据库的PD端口，默认为2379。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认6000毫秒。 | +| JDBC端口 | TiDB数据库对外提供用于客户端请求的端口，默认为4000。 | +| 数据库名称 | 数据库实例名称，可选。 | +| 用户名 | 数据库连接用户名，可选 | +| 密码 | 数据库连接密码，可选 | +| JDBC URL | 数据库使用[JDBC驱动的](https://docs.pingcap.com/zh/tidb/stable/dev-guide-connect-to-tidb#jdbc)连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 @@ -35,15 +35,13 @@ keywords: [开源监控系统, 开源数据库监控, TiDB数据库监控] #### 指标集合：系统变量 -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| version | 无 | MySQL 的版本和 TiDB 的版本，例如 '8.0.11-TiDB-v7.5.1' | -| version_comment | 无 | TiDB 版本号的其他信息，例如 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible' | -| version_compile_machine | 无 | 运行 TiDB 的 CPU 架构的名称 | -| version_compile_os | 无 | TiDB 所在操作系统的名称 | -| max_connections | 无 | 该变量表示 TiDB 中同时允许的最大客户端连接数，用于资源控制。默认情况下，该变量值为 0 表示不限制客户端连接数。当本变量的值大于 0 且客户端连接数到达此值时，TiDB 服务端将会拒绝新的客户端连接。 | -| datadir | 无 | 数据存储的位置，位置可以是本地路径 /tmp/tidb。如果数据存储在 TiKV 上，则可以是指向 PD 服务器的路径。变量值的格式为 ${pd-ip}:${pd-port}，表示 TiDB 在启动时连接到的 PD 服务器。 | -| port | 无 | 使用 MySQL 协议时 tidb-server 监听的端口。 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|------------------------------------------------------------------------------------------------------------------| +| version | 无 | MySQL 的版本和 TiDB 的版本，例如 '8.0.11-TiDB-v7.5.1' | +| version_comment | 无 | TiDB 版本号的其他信息，例如 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible' | +| version_compile_machine | 无 | 运行 TiDB 的 CPU 架构的名称 | +| version_compile_os | 无 | TiDB 所在操作系统的名称 | +| max_connections | 无 | 该变量表示 TiDB 中同时允许的最大客户端连接数，用于资源控制。默认情况下，该变量值为 0 表示不限制客户端连接数。当本变量的值大于 0 且客户端连接数到达此值时，TiDB 服务端将会拒绝新的客户端连接。 | +| datadir | 无 | 数据存储的位置，位置可以是本地路径 /tmp/tidb。如果数据存储在 TiKV 上，则可以是指向 PD 服务器的路径。变量值的格式为 ${pd-ip}:${pd-port}，表示 TiDB 在启动时连接到的 PD 服务器。 | +| port | 无 | 使用 MySQL 协议时 tidb-server 监听的端口。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md index f03ebfab25e..8b5e6c8aca9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md @@ -23,7 +23,7 @@ ${FORMATTER [{ + | - } ]} > 示例输出以当前时间为 `2022-04-24 02:40:00.123` -| 名称 | 描述 | 示例 | +| 名称 | 描述 | 示例 | |--------------|----------------------------|---------------------| | @now | 格式化为 `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | | @date | 格式化为 `yyyy-MM-dd` | 2022-04-24 | @@ -42,9 +42,9 @@ ${FORMATTER [{ + | - } ]} | 名称 | 描述 | |----|----| -| y | 年 | +| y | 年 | | M | 月 | -| d | 日 | +| d | 日 | | H | 小时 | | m | 分钟 | | s | 秒 | @@ -57,10 +57,9 @@ ${FORMATTER [{ + | - } ]} #### 使用示例 1. 简单表达式 - - `${now}` 获取当前时间，并格式化为 `yyyy-MM-dd HH:mm:ss` - - `${time+1h}` 计算当前时间一小时之后的时间，并格式化为 `HH:mm:ss` - - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间，并格式化为 `HH:mm:ss` + - `${now}` 获取当前时间，并格式化为 `yyyy-MM-dd HH:mm:ss` + - `${time+1h}` 计算当前时间一小时之后的时间，并格式化为 `HH:mm:ss` + - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间，并格式化为 `HH:mm:ss` 2. 复杂表达式模板（如果内置的格式化器无法满足需要，可以组合使用多个表达式） - - `${@year}年${@month}月${@day}日`，获取当前日期并按照 yyyy年MM月dd日格式返回 - + - `${@year}年${@month}月${@day}日`，获取当前日期并按照 yyyy年MM月dd日格式返回 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md index c306bebc550..b366ee3c2ac 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md @@ -11,67 +11,65 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | JMX连接用户名 | -| 密码 | JMX连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 查询超时时间 | 设置Tomcat连接的超时时间，单位ms毫秒，默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 - #### 指标集合：memory_pool -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| name | 无 | 指标名称 | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：code_cache -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| committed | kb | 总量 | -| init | kb | 初始化大小 | -| max | kb | 最大 | -| used | kb | 已使用 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | #### 指标集合：class_loading -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| LoadedClassCount | 个 | 已加载类数量 | -| TotalLoadedClassCount | 个 | 历史已加载类总量 | -| UnloadedClassCount | 个 | 未加载类数量 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | #### 指标集合：thread -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| TotalStartedThreadCount | 个 | 已经开始的线程数量 | -| ThreadCount | 个 | 线程数 | -| PeakThreadCount | 个 | 未加载类数量 | -| DaemonThreadCount | 个 | 守护进程数 | -| CurrentThreadUserTime | ms | 使用时间 | -| CurrentThreadCpuTime | ms | 使用CPU时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|-----------| +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | ### Tomcat开启JMX协议步骤 -1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 +1. 搭建好tomcat后，进入tomcat下的bin目录，修改catalina.sh文件 注意⚠️替换IP地址 -2. vim catalina.sh +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" ``` -参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 +参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md index e5d1be3a140..3ec51e5464a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md @@ -9,74 +9,74 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Linux SSH对外提供的端口，默认为22。 | -| 用户名 | SSH连接用户名，可选 | -| 密码 | SSH连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口，默认为22。 | +| 用户名 | SSH连接用户名，可选 | +| 密码 | SSH连接密码，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：basic -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| hostname | 无 | 主机名称 | -| version | 无 | 操作系统版本 | -| uptime | 无 | 系统运行时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| hostname | 无 | 主机名称 | +| version | 无 | 操作系统版本 | +| uptime | 无 | 系统运行时间 | #### 指标集合：cpu -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| info | 无 | CPU型号 | -| cores | 核数 | CPU内核数量 | -| interrupt | 个数 | CPU中断数量 | -| load | 无 | CPU最近1/5/15分钟的平均负载 | -| context_switch | 个数 | 当前上下文切换数量 | -| usage | % | 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 | % | 内存使用率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | #### 指标集合：disk -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| disk_num | 块数 | 磁盘总数 | -| partition_num | 分区数 | 分区总数 | -| block_write | 块数 | 写入磁盘的总块数 | -| block_read | 块数 | 从磁盘读出的块数 | -| write_rate | iops | 每秒写磁盘块的速率 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | #### 指标集合：interface -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| interface_name | 无 | 网卡名称 | -| receive_bytes | byte | 入站数据流量(bytes) | -| transmit_bytes | byte | 出站数据流量(bytes) | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|---------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | #### 指标集合：disk_free -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| filesystem | 无 | 文件系统的名称 | -| used | Mb | 已使用磁盘大小 | -| available | Mb | 可用磁盘大小 | -| usage | % | 使用率 | -| mounted | 无 | 挂载点目录 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md index 06c11717b25..ee2f388873b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md @@ -10,7 +10,7 @@ keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |:-------|--------------------------------------------------------| | 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头 (例如: https://, http://) 。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -26,6 +26,7 @@ keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] #### 指标集合：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |------|---------|--------| | 响应时间 | 毫秒 (ms) | 网站响应时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md index 5dbb2f2c7c6..8efe5262612 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md @@ -5,26 +5,26 @@ sidebar_label: 网站监测 keywords: [开源监控系统, 开源网站监控] --- -> 对网站是否可用，响应时间等指标进行监测 +> 对网站是否可用，响应时间等指标进行监测 -### 配置参数 +### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | -| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | -| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|---------|-------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口，http一般默认为80，https一般默认为443。 | +| 相对路径 | 网站地址除IP端口外的后缀路径，例如 `www.tancloud.io/console` 网站的相对路径为 `/console`。 | +| 启用HTTPS | 是否通过HTTPS访问网站，注意⚠️开启HTTPS一般默认对应端口需要改为443 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | -### 采集指标 +### 采集指标 -#### 指标集合：summary +#### 指标集合：summary -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| responseTime | ms毫秒 | 网站响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms毫秒 | 网站响应时间 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md index ad8baa7d71b..3bd02f3ce18 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md @@ -9,7 +9,7 @@ keywords: [ 开源监控系统, Websocket监控 ] ### 配置参数 -| 参数名称 | 参数帮助描述 | +| 参数名称 | 参数帮助描述 | |------------------|--------------------------------------------------------------| | WebSocket服务的Host | 被监控的Websocket的IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | | 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | @@ -23,7 +23,7 @@ keywords: [ 开源监控系统, Websocket监控 ] #### 指标集合：概要 -| 指标名称 | 指标单位 | 指标帮助描述 | +| 指标名称 | 指标单位 | 指标帮助描述 | |---------------|------|---------| | responseTime | ms | 响应时间 | | httpVersion | 无 | HTTP 版本 | @@ -31,3 +31,4 @@ keywords: [ 开源监控系统, Websocket监控 ] | statusMessage | 无 | 状态消息 | | connection | 无 | 表示连接方式 | | upgrade | 无 | 升级后的协议 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md index 6a1c79b9ede..41447469e61 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md @@ -6,38 +6,39 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 --- > 通过SNMP协议对Windows操作系统的通用性能指标进行采集监控。 -> 注意⚠️ Windows服务器需开启SNMP服务 +> 注意⚠️ 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) +[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 | +| 参数名称 | 参数帮助描述 | +|----------|----------------------------------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | +| 端口 | Windows SNMP服务对外提供的端口，默认为 161。 | +| SNMP 版本 | SNMP协议版本 V1 V2c V3 | | SNMP 团体字 | SNMP 协议团体名(Community Name)，用于实现SNMP网络管理员访问SNMP管理代理时的身份验证。类似于密码，默认值为 public | -| 超时时间 | 协议连接超时时间 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 超时时间 | 协议连接超时时间 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：system -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| name | 无 | 主机名称 | -| descr | 无 | 操作系统描述 | -| uptime | 无 | 系统运行时间 | -| numUsers | 个数 | 当前用户数 | -| services | 个数 | 当前服务数量 | -| processes | 个数 | 当前进程数量 | -| responseTime | ms | 采集响应时间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| name | 无 | 主机名称 | +| descr | 无 | 操作系统描述 | +| uptime | 无 | 系统运行时间 | +| numUsers | 个数 | 当前用户数 | +| services | 个数 | 当前服务数量 | +| processes | 个数 | 当前进程数量 | +| responseTime | ms | 采集响应时间 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md index 2c88fe1e5a9..c35a0226876 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md @@ -15,69 +15,70 @@ keywords: [大数据监控系统, Apache Yarn监控, 资源管理器监控] ## 配置参数 -| 参数名称 | 参数帮助描述 | -| ---------------- |---------------------------------------| -| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | -| 端口 | Apache Yarn 的监控端口号，默认为8088。 | -| 查询超时时间 | 查询 Apache Yarn 的超时时间，单位毫秒，默认6000毫秒。 | -| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | +| 参数名称 | 参数帮助描述 | +|--------|-------------------------------------| +| 目标Host | 被监控的对端IPV4，IPV6或域名。不带协议头。 | +| 端口 | Apache Yarn 的监控端口号，默认为8088。 | +| 查询超时时间 | 查询 Apache Yarn 的超时时间，单位毫秒，默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔，单位秒，最小间隔为30秒。 | ### 采集指标 #### 指标集合：ClusterMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | ---------------------------------- | -| NumActiveNMs | | 当前存活的 NodeManager 个数 | -| NumDecommissionedNMs | | 当前 Decommissioned 的 NodeManager 个数 | -| NumDecommissioningNMs| | 集群正在下线的节点数 | -| NumLostNMs | | 集群丢失的节点数 | -| NumUnhealthyNMs | | 集群不健康的节点数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|------------------------------------| +| NumActiveNMs | | 当前存活的 NodeManager 个数 | +| NumDecommissionedNMs | | 当前 Decommissioned 的 NodeManager 个数 | +| NumDecommissioningNMs | | 集群正在下线的节点数 | +| NumLostNMs | | 集群丢失的节点数 | +| NumUnhealthyNMs | | 集群不健康的节点数 | #### 指标集合：JvmMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | ------------------------------------ | -| MemNonHeapCommittedM | MB | JVM当前非堆内存大小已提交大小 | -| MemNonHeapMaxM | MB | JVM非堆最大可用内存 | -| MemNonHeapUsedM | MB | JVM当前已使用的非堆内存大小 | -| MemHeapCommittedM | MB | JVM当前已使用堆内存大小 | -| MemHeapMaxM | MB | JVM堆内存最大可用内存 | -| MemHeapUsedM | MB | JVM当前已使用堆内存大小 | -| GcTimeMillis | | JVM GC时间 | -| GcCount | | JVM GC次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|------------------| +| MemNonHeapCommittedM | MB | JVM当前非堆内存大小已提交大小 | +| MemNonHeapMaxM | MB | JVM非堆最大可用内存 | +| MemNonHeapUsedM | MB | JVM当前已使用的非堆内存大小 | +| MemHeapCommittedM | MB | JVM当前已使用堆内存大小 | +| MemHeapMaxM | MB | JVM堆内存最大可用内存 | +| MemHeapUsedM | MB | JVM当前已使用堆内存大小 | +| GcTimeMillis | | JVM GC时间 | +| GcCount | | JVM GC次数 | #### 指标集合：QueueMetrics -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------------------ | -------- | ------------------------------------ | -| queue | | 队列名称 | -| AllocatedVCores | | 分配的虚拟核数(已分配) | -| ReservedVCores | | 预留核数 | -| AvailableVCores | | 可用核数(尚未分配) | -| PendingVCores | | 阻塞调度核数 | -| AllocatedMB | MB | 已分配(已用)的内存大小 | -| AvailableMB | MB | 可用内存(尚未分配) | -| PendingMB | MB | 阻塞调度内存 | -| ReservedMB | MB | 预留内存 | -| AllocatedContainers | | 已分配(已用)的container数 | -| PendingContainers | | 阻塞调度container个数 | -| ReservedContainers | | 预留container数 | -| AggregateContainersAllocated | | 累积的container分配总数 | -| AggregateContainersReleased | | 累积的container释放总数 | -| AppsCompleted | | 完成的任务数 | -| AppsKilled | | 被杀掉的任务数 | -| AppsFailed | | 失败的任务数 | -| AppsPending | | 阻塞的任务数 | -| AppsRunning | | 提正在运行的任务数 | -| AppsSubmitted | | 提交过的任务数 | -| running_0 | | 运行时间小于60分钟的作业个数 | -| running_60 | | 运行时间介于60~300分钟的作业个数 | -| running_300 | | 运行时间介于300~1440分钟的作业个数 | -| running_1440 | | 运行时间大于1440分钟的作业个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|------|-----------------------| +| queue | | 队列名称 | +| AllocatedVCores | | 分配的虚拟核数(已分配) | +| ReservedVCores | | 预留核数 | +| AvailableVCores | | 可用核数(尚未分配) | +| PendingVCores | | 阻塞调度核数 | +| AllocatedMB | MB | 已分配(已用)的内存大小 | +| AvailableMB | MB | 可用内存(尚未分配) | +| PendingMB | MB | 阻塞调度内存 | +| ReservedMB | MB | 预留内存 | +| AllocatedContainers | | 已分配(已用)的container数 | +| PendingContainers | | 阻塞调度container个数 | +| ReservedContainers | | 预留container数 | +| AggregateContainersAllocated | | 累积的container分配总数 | +| AggregateContainersReleased | | 累积的container释放总数 | +| AppsCompleted | | 完成的任务数 | +| AppsKilled | | 被杀掉的任务数 | +| AppsFailed | | 失败的任务数 | +| AppsPending | | 阻塞的任务数 | +| AppsRunning | | 提正在运行的任务数 | +| AppsSubmitted | | 提交过的任务数 | +| running_0 | | 运行时间小于60分钟的作业个数 | +| running_60 | | 运行时间介于60~300分钟的作业个数 | +| running_300 | | 运行时间介于300~1440分钟的作业个数 | +| running_1440 | | 运行时间大于1440分钟的作业个数 | #### 指标集合：runtime -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------------------- | -------- | ---------------------------- | -| StartTime | | 启动时间戳 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| StartTime | | 启动时间戳 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md index 0783ceaf3fb..14d50c3c90d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, Zookeeper监控监控] > 监控 zookeeper 目前的实现方案使用的是 zookeeper 提供的四字命令 + netcat 来收集指标数据 > 需要用户自己将zookeeper的四字命令加入白名单 -1. 加白名单步骤 +1. 加白名单步骤 > 1.找到我们 zookeeper 的配置文件，一般是 `zoo.cfg` > @@ -25,76 +25,76 @@ keywords: [开源监控系统, Zookeeper监控监控] # 将所有命令添加到白名单中 4lw.commands.whitelist=* ``` + > 3.重启服务 -```shell +```shell zkServer.sh restart ``` -2. netcat 协议 +2. netcat 协议 目前实现方案需要我们部署zookeeper的linux服务器，安装netcat的命令环境 > netcat安装步骤 -```shell -yum install -y nc -``` +> +> ```shell +> yum install -y nc +> ``` 如果终端显示以下信息则说明安装成功 + ```shell Complete! ``` - ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | Zookeeper的Linux服务器SSH端口。 | -| 查询超时时间 | 设置Zookeeper连接的超时时间，单位ms毫秒，默认3000毫秒。 | -| 用户名 | Zookeeper所在Linux连接用户名 | -| 密码 | Zookeeper所在Linux连接密码 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 服务器编号 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|----------------------------------------| +| 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 | 最小延时 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------------|------|------------| +| 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.5.x/introduce.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md index cd0274a5f98..5c3f1f90feb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md @@ -16,7 +16,6 @@ slug: / [![QQ](https://img.shields.io/badge/QQ-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) [![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) - ## 🎡 介绍 [Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 @@ -31,7 +30,7 @@ slug: / - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 - 提供强大的状态页构建能力，轻松向用户传达您产品服务的实时状态。 -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ---- @@ -48,7 +47,6 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![hertzbeat](/img/home/9.png) - ### 内置监控类型 **官方内置了大量的监控模版类型，方便用户直接在页面添加使用，一款监控类型对应一个YML监控模版** @@ -113,11 +111,11 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 高性能集群 -> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 +> 当监控数量指数级上升，采集性能下降或者环境不稳定容易造成采集器单点故障时，这时我们的采集器集群就出场了。 -- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 -- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 +- `HertzBeat` 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 +- 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 +- 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 ![hertzbeat](/img/docs/cluster-arch.png) @@ -134,10 +132,10 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 易用友好 -- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 -- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 -- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 -- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 +- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 +- 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 +- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 +- 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 - 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 ### 完全开源 @@ -151,8 +149,7 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![cncf](/img/home/cncf-landscape-left-logo.svg) ------ - +--- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ----- @@ -269,7 +266,6 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/13.png) - ### 告警静默 - 当通过阈值规则判断触发告警后，会进入到告警静默，告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默，此时间段不发送告警消息。 @@ -301,8 +297,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/9.png) - ------ +--- **还有更多强大的功能快去探索呀。Have Fun!** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md index 7799d12fe52..7f3854c3e12 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md @@ -1,9 +1,9 @@ --- id: design title: 设计文档 -sidebar_label: 设计文档 +sidebar_label: 设计文档 --- -### HertzBeat 架构 +### HertzBeat 架构 -![architecture](/img/docs/hertzbeat-arch.svg) +![architecture](/img/docs/hertzbeat-arch.svg) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md index 46699d69a23..0e01e014901 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md @@ -1,20 +1,20 @@ --- id: resource title: 相关资源 -sidebar_label: 相关资源 +sidebar_label: 相关资源 --- -## 图标资源 +## 图标资源 -### HertzBeat LOGO +### HertzBeat LOGO ![logo](/img/hertzbeat-logo.svg) Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) -### HertzBeat Brand LOGO +### HertzBeat Brand LOGO ![logo](/img/hertzbeat-brand.svg) -Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) +Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md index 710ae8cbee5..7ad94c08b93 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md @@ -1,7 +1,7 @@ --- id: account-modify title: 配置修改账户密码和加密密钥 -sidebar_label: 更新账户和密钥 +sidebar_label: 更新账户和密钥 --- ## 更新账户 @@ -9,7 +9,7 @@ sidebar_label: 更新账户和密钥 Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射 -配置文件内容参考 项目仓库[/script/sureness.yml](https://github.com/apache/hertzbeat/blob/master/script/sureness.yml) +配置文件内容参考 项目仓库[/script/sureness.yml](https://github.com/apache/hertzbeat/blob/master/script/sureness.yml) ```yaml @@ -127,4 +127,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** +**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md index 7dde7ec14e9..01380784169 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md @@ -1,23 +1,25 @@ --- id: custom-config title: 常见参数配置 -sidebar_label: 常见参数配置 +sidebar_label: 常见参数配置 --- 这里描述了如果配置短信服务器，内置可用性告警触发次数等。 -**`hertzbeat`的配置文件`application.yml`** +**`hertzbeat`的配置文件`application.yml`** -### 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 - 安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 +### 配置HertzBeat的配置文件 + +修改位于 `hertzbeat/config/application.yml` 的配置文件 +注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 +安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 1. 配置短信发送服务器 -> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 +> 只有成功配置了您自己的短信服务器，监控系统内触发的告警短信才会正常发送。 + +在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) -在`application.yml`新增如下腾讯平台短信服务器配置(参数需替换为您的短信服务器配置) ```yaml common: sms: @@ -28,15 +30,17 @@ common: sign-name: 赫兹跳动 template-id: 1343434 ``` + 1.1 腾讯云短信创建签名（sign-name） ![image](https://github.com/apache/hertzbeat/assets/40455946/3a4c287d-b23d-4398-8562-4894296af485) 1.2 腾讯云短信创建正文模板（template-id） + ``` 监控:{1}，告警级别:{2}。内容:{3} ``` -![image](https://github.com/apache/hertzbeat/assets/40455946/face71a6-46d5-452c-bed3-59d2a975afeb) +![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) @@ -44,8 +48,7 @@ common: 1.4 腾讯云访问管理（secret-id、secret-key） ![image](https://github.com/apache/hertzbeat/assets/40455946/36f056f0-94e7-43db-8f07-82893c98024e) - -2. 配置告警自定义参数 +2. 配置告警自定义参数 ```yaml alerter: @@ -53,11 +56,12 @@ alerter: console-url: https://console.tancloud.io ``` -3. 使用外置redis代替内存存储实时指标数据 +3. 使用外置redis代替内存存储实时指标数据 -> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 +> 默认我们的指标实时数据存储在内存中，可以配置如下来使用redis代替内存存储。 + +注意⚠️ `memory.enabled: false, redis.enabled: true` -注意⚠️ `memory.enabled: false, redis.enabled: true` ```yaml warehouse: store: @@ -70,3 +74,4 @@ warehouse: port: 6379 password: 123456 ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md index 89cb46ef951..aa01b6f5d30 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md @@ -1,14 +1,14 @@ --- id: docker-deploy title: 通过 Docker 方式安装 HertzBeat -sidebar_label: Docker方式部署 +sidebar_label: Docker方式部署 --- -> 推荐使用 Docker 部署 Apache HertzBeat (incubating) +> 推荐使用 Docker 部署 Apache HertzBeat (incubating) 1. 下载安装Docker环境 Docker 工具自身的下载请参考以下资料： - [Docker官网文档](https://docs.docker.com/get-docker/) + [Docker官网文档](https://docs.docker.com/get-docker/) [菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html) 安装完毕后终端查看Docker版本是否正常输出。 @@ -16,7 +16,6 @@ sidebar_label: Docker方式部署 $ docker -v Docker version 20.10.12, build e91ed57 ``` - 2. 拉取HertzBeat Docker镜像 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) 或者使用 [quay.io 镜像仓库](https://quay.io/repository/apache/hertzbeat) @@ -25,12 +24,13 @@ sidebar_label: Docker方式部署 $ 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 @@ -46,25 +46,22 @@ sidebar_label: Docker方式部署 ctrl+d或者 $ exit ``` - 4. 挂载并配置HertzBeat的配置文件(可选) 下载 `application.yml` 文件到主机目录下，例如: $(pwd)/application.yml - 下载源 [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + 下载源 [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - 若需使用邮件发送告警，需替换 `application.yml` 里面的邮件服务器参数 - - **推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)） - - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) - - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) - + - **推荐**若需使用外置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) - 具体修改步骤参考 [配置修改账户密码](account-modify) - -6. 启动HertzBeat Docker容器 + 具体修改步骤参考 [配置修改账户密码](account-modify) +6. 启动HertzBeat Docker容器 -```shell +```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=zh_CN.UTF-8 \ -e TZ=Asia/Shanghai \ @@ -76,34 +73,31 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ --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`代替。** + 这条命令启动一个运行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 - 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 8. 部署采集器集群(可选) -```shell +```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ @@ -112,52 +106,57 @@ $ docker run -d \ --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`代替。** +这条命令启动一个运行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` 查看概览页面即可看到注册上来的新采集器 +8. 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 -**HAVE FUN** +**HAVE FUN** -### Docker部署常见问题 +### Docker部署常见问题 **最多的问题就是网络问题，请先提前排查** 1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** -此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 + > 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP -> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` +> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` 2. **按照流程部署，访问 http://ip:1157/ 无界面** -请参考下面几点排查问题： + 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 -3. **日志报错TDengine连接或插入SQL失败** +3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter + +4. **监控历史图表长时间都一直无数据** -4. **监控历史图表长时间都一直无数据** > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB或Tdengine IP账户密码等配置是否正确 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB或Tdengine IP账户密码等配置是否正确 5. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - -> 安装初始化此数据库参考 [TDengine安装初始化](tdengine-init) 或 [IoTDB安装初始化](iotdb-init) +> 安装初始化此数据库参考 [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.5.x/start/greptime-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/greptime-init.md index c83f0638605..5bf5faaf76e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/greptime-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/greptime-init.md @@ -1,7 +1,7 @@ --- id: greptime-init title: 依赖时序数据库服务GreptimeDB安装初始化 -sidebar_label: 使用GreptimeDB存储指标数据(可选) +sidebar_label: 使用GreptimeDB存储指标数据(可选) --- Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) @@ -11,18 +11,21 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 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 -### 通过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 +> 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 \ @@ -33,16 +36,16 @@ $ docker run -p 4000-4004:4000-4004 \ --rpc-addr 0.0.0.0:4001 ``` - `-v /opt/greptimedb:/tmp/greptimedb` 为greptimedb数据目录本地持久化挂载，需将`/opt/greptimedb`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/greptimedb:/tmp/greptimedb` 为greptimedb数据目录本地持久化挂载，需将`/opt/greptimedb`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.greptime`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -57,8 +60,9 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库 GreptimeDB 或者 IoTDB 或者 TDengine 是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md index 427f07af423..ccff933ac1f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md @@ -1,36 +1,39 @@ --- id: influxdb-init title: 依赖时序数据库服务InfluxDB安装初始化 -sidebar_label: 使用InfluxDB存储指标数据(可选) +sidebar_label: 使用InfluxDB存储指标数据(可选) --- Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 +InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** ### 1. 直接使用华为云服务 GaussDB For Influx -> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) - +> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) +> > 获取云数据库对外暴露连接地址，账户密码即可 ⚠️注意云数据库默认开启了SSL，云数据库地址应使用 `https:` -### 2. 通过Docker方式安装InfluxDB +### 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 +> 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 \ @@ -38,17 +41,16 @@ $ docker run -p 8086:8086 \ influxdb:1.8 ``` - `-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 - -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -67,10 +69,9 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 -1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 +1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md index b4888e2af03..b24eba892a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md @@ -3,6 +3,7 @@ id: iotdb-init title: 依赖时序数据库服务IoTDB安装初始化 sidebar_label: 使用IoTDB存储指标数据(可选) --- + Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 @@ -89,16 +90,15 @@ warehouse: 参数说明： - -| 参数名称 | 参数说明 | -| ------------------- |-------------------------------------------| +| 参数名称 | 参数说明 | +|---------------------|-------------------------------------------| | enabled | 是否启用 | | host | IoTDB数据库地址 | | rpc-port | IoTDB数据库端口 | | node-urls | IoTDB集群地址 | | username | IoTDB数据库账户 | | password | IoTDB数据库密码 | -| version | IoTDB数据库版本，已废弃，仅支持V1.* | +| version | IoTDB数据库版本，已废弃，仅支持V1.* | | query-timeout-in-ms | 查询超时时间 | | expire-time | 数据存储时间，默认'7776000000'（90天,单位为毫秒,-1代表永不过期） | @@ -122,3 +122,4 @@ warehouse: > iot-db enable是否设置为true > 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md index b25a8408387..1d122575d2c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md @@ -1,23 +1,27 @@ --- id: mysql-change title: 关系型数据库使用 Mysql 替换依赖的 H2 存储系统元数据 -sidebar_label: 元数据使用Mysql存储(可选) +sidebar_label: 元数据使用Mysql存储(可选) --- -MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 + +MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外，还可以切换为使用MYSQL存储监控信息，告警信息，配置信息等结构化关系数据。 注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 -> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 +> 如果您已有MYSQL环境，可直接跳到数据库创建那一步。 + +### 通过Docker方式安装MYSQL -### 通过Docker方式安装MYSQL 1. 下载安装Docker环境 Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 - 安装完毕后请于终端检查Docker版本输出是否正常。 + 安装完毕后请于终端检查Docker版本输出是否正常。 + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. Docker安装MYSQl +2. Docker安装MYSQl + ``` $ docker run -d --name mysql \ -p 3306:3306 \ @@ -26,26 +30,29 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) --restart=always \ mysql:5.7 ``` + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 -### 数据库创建 +### 数据库创建 + 1. 进入MYSQL或使用客户端连接MYSQL服务 - `mysql -uroot -p123456` + `mysql -uroot -p123456` 2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 查看hertzbeat数据库是否创建成功 `show databases;` -### 修改hertzbeat的配置文件application.yml切换数据源 +### 修改hertzbeat的配置文件application.yml切换数据源 - 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 - ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + + 需修改部分原参数: - 需修改部分原参数: ```yaml spring: datasource: @@ -54,7 +61,9 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL ``` - 具体替换参数如下,需根据mysql环境配置账户密码IP: + + 具体替换参数如下,需根据mysql环境配置账户密码IP: + ```yaml spring: datasource: @@ -66,12 +75,11 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) jpa: database: mysql ``` +- 通过docker启动时，建议修改host为宿主机的外网IP地址，包括mysql连接字符串和redis。 -- 通过docker启动时，建议修改host为宿主机的外网IP地址，包括mysql连接字符串和redis。 +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** - -### 常见问题 +### 常见问题 1. 缺少hibernate的mysql方言，导致启动异常 Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set @@ -87,3 +95,4 @@ spring: hibernate: dialect: org.hibernate.dialect.MySQL5InnoDBDialect ``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md index b5f9d7e0456..894c58f1e3b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md @@ -1,21 +1,23 @@ --- id: package-deploy title: 通过安装包安装 HertzBeat -sidebar_label: 安装包方式部署 +sidebar_label: 安装包方式部署 --- + > Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 - + 1. 下载HertzBeat安装包 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` - [下载页面](/docs/download) - 2. 配置HertzBeat的配置文件(可选) - 解压安装包到主机 eg: /opt/hertzbeat - ``` + 解压安装包到主机 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)） @@ -26,20 +28,20 @@ sidebar_label: 安装包方式部署 3. 配置用户配置文件(可选,自定义配置用户密码) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 - 具体参考 [配置修改账户密码](account-modify) + 具体参考 [配置修改账户密码](account-modify) 4. 部署启动 - 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - ``` + 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat + + ``` $ ./startup.sh ``` - 5. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 - + 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 6. 部署采集器集群(可选) - - 下载解压您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [下载页面](/docs/download) + - 下载解压您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [下载页面](/docs/download) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` + ```yaml collector: dispatch: @@ -56,7 +58,6 @@ sidebar_label: 安装包方式部署 **HAVE FUN** - ### 安装包部署常见问题 **最多的问题就是网络环境问题，请先提前排查** @@ -67,25 +68,30 @@ sidebar_label: 安装包方式部署 要求：JAVA17环境 下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) 安装后命令行检查是否成功安装 - ``` - $ java -version - java version "17.0.9" - Java(TM) SE Runtime Environment 17.0.9 (build 17.0.9+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) - ``` +``` +$ java -version +java version "17.0.9" +Java(TM) SE Runtime Environment 17.0.9 (build 17.0.9+8-LTS-237) +Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) + +``` 2. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** + > 一：排查配置的数据库账户密码是否正确，数据库是否创建 -> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter +> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter 4. **监控历史图表长时间都一直无数据** + > 一：时序数据库是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md index 3d554d84f0a..6a48c741201 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md @@ -3,42 +3,43 @@ id: postgresql-change title: 关系型数据库使用 PostgreSQL 替换依赖的 H2 存储系统元数据 sidebar_label: 元数据使用PostgreSQL存储(可选) --- -PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBMS）。Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外，还可以切换为使用PostgreSQL存储监控信息，告警信息，配置信息等结构化关系数据。 -注意⚠️ 使用外置PostgreSQL数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 +PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBMS）。Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外，还可以切换为使用PostgreSQL存储监控信息，告警信息，配置信息等结构化关系数据。 -> 如果您已有PostgreSQL环境，可直接跳到数据库创建那一步。 +注意⚠️ 使用外置PostgreSQL数据库替换内置H2数据库为可选项，但建议生产环境配置，以提供更好的性能 +> 如果您已有PostgreSQL环境，可直接跳到数据库创建那一步。 -### 通过Docker方式安装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 服务 -1. 进入 PostgreSQL 或使用客户端连接 PostgreSQL 服务 ``` su - postgres psql ``` - 2. 创建名称为hertzbeat的数据库 `CREATE DATABASE hertzbeat;` - 3. 查看hertzbeat数据库是否创建成功 `\l` @@ -58,7 +59,9 @@ spring: password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL ``` + 具体替换参数如下,需根据 PostgreSQL 环境配置账户密码IP: + ```yaml spring: config: @@ -81,4 +84,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md index 90d38032d0e..918bfdea17a 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 @@ -1,18 +1,18 @@ --- id: quickstart title: 快速开始 -sidebar_label: 快速开始 +sidebar_label: 快速开始 --- ### 🐕 开始使用 - 如果您是想将 Apache HertzBeat (incubating) 部署到本地搭建监控系统，请参考下面的部署文档进行操作。 +### 🍞 HertzBeat安装 -### 🍞 HertzBeat安装 > HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持X86/ARM64。 -#### 方式一：Docker方式快速安装 +#### 方式一：Docker方式快速安装 1. `docker` 环境仅需一条命令即可开始 @@ -29,14 +29,15 @@ sidebar_label: 快速开始 ``` 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) +更多配置详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy) -#### 方式二：通过安装包安装 +#### 方式二：通过安装包安装 1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [Download](https://hertzbeat.apache.org/docs/download) 2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) @@ -45,6 +46,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 5. 部署采集器集群(可选) - 下载您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [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: @@ -59,9 +61,9 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 -更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) +更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) -#### 方式三：本地代码启动 +#### 方式三：本地代码启动 1. 此为前后端分离项目，本地代码调试需要分别启动后端工程`manager`和前端工程`web-app` 2. 后端：需要`maven3+`, `java17`和`lombok`环境，修改`YML`配置信息并启动`manager`服务 @@ -74,7 +76,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 通过 [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) +详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) ##### 方式五：Kubernetes Helm Charts 部署 hertzbeat+collector+mysql+iotdb @@ -121,4 +123,4 @@ $ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ apache/iotdb:0.13.3-node ``` -详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) +详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md index 5da0679d327..8e01b8cf7a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md @@ -1,7 +1,7 @@ --- id: rainbond-deploy title: 使用 Rainbond 部署 HertzBeat -sidebar_label: Rainbond方式部署 +sidebar_label: Rainbond方式部署 --- 如果你不熟悉 Kubernetes，想在 Kubernetes 中安装 Apache HertzBeat (incubating)，可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台，可以很简单的将你的应用部署到 Kubernetes中。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md index 62cd3e157a3..a6efb36482d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md @@ -4,7 +4,6 @@ title: SSL证书过期监控使用案例 sidebar_label: 使用案例 --- - 现在大部分网站都默认支持 HTTPS，我们申请的证书一般是3个月或者1年，很容易随着时间的流逝SSL证书过期了我们却没有第一时间发现，或者在过期之前没有及时更新证书。 这篇文章介绍如果使用 hertzbeat 监控系统来检测我们网站的SSL证书有效期，当证书过期时或证书快过期前几天，给我们发告警消息。 @@ -13,7 +12,6 @@ sidebar_label: 使用案例 Apache HertzBeat (incubating) 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 - github: https://github.com/apache/hertzbeat #### 安装 HertzBeat @@ -30,10 +28,8 @@ github: https://github.com/apache/hertzbeat > 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书 - ![](/img/docs/start/ssl_1.png) - 2. 配置监控网站 > 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md index 7fcd8fd460e..85c6db66eb2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md @@ -1,31 +1,33 @@ --- id: tdengine-init title: 依赖时序数据库服务TDengine安装初始化 -sidebar_label: 使用TDengine存储指标数据(可选) +sidebar_label: 使用TDengine存储指标数据(可选) --- Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 +TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 +### 通过Docker方式安装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 +> 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 \ @@ -34,23 +36,23 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ tdengine/tdengine:3.0.4.0 ``` - `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 - `-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 - 使用```$ docker ps```查看数据库是否启动成功 +`-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 +`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 +使用```$ docker ps```查看数据库是否启动成功 + +### 创建数据库实例 -### 创建数据库实例 +> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) -> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) +1. 进入数据库Docker容器 -1. 进入数据库Docker容器 ``` $ docker exec -it tdengine /bin/bash ``` - 2. 修改账户密码 > 建议您修改密码。TDengine默认的账户密码是 root/taosdata - > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: + > 进入容器后，执行 `taos` 命令进入TDengine CLI , 如下: ``` root@tdengine-server:~/TDengine-server# taos @@ -58,6 +60,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. taos> ``` + > 在 TDengine CLI 中使用 alter user 命令可以修改用户密码，缺省密码为 taosdata 3. 创建名称为hertzbeat的数据库 @@ -77,24 +80,23 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ taos> show databases; taos> use hertzbeat; ``` - 5. 退出TDengine CLI ``` 输入 q 或 quit 或 exit 回车 ``` -**注意⚠️若是安装包安装的TDengine** +**注意⚠️若是安装包安装的TDengine** > 除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter -### 在hertzbeat的`application.yml`配置文件配置此数据库连接 +### 在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` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.td-engine`数据源参数，URL账户密码，并启用`enabled`为`true`** ```yaml warehouse: @@ -112,19 +114,24 @@ warehouse: 2. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库IoTDB和TDengine是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 -2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] +2. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 如弹窗所示，历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 -3. 监控详情历史图片不展示或无数据，已经配置了TDengine +3. 监控详情历史图片不展示或无数据，已经配置了TDengine + > 请确认是否安装的TDengine版本为3.0以上，版本2.x不支持兼容 4. 安装配置了TDengine数据库，但页面依旧显示弹出 [无法提供历史图表数据，请配置依赖时序数据库] + > 请检查配置参数是否正确 > td-engine enable是否设置为true > 注意⚠️若hertzbeat和TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP -> 可根据logs目录下启动日志排查 +> 可根据logs目录下启动日志排查 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md index b84726b38e0..e528f8b60c6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md @@ -1,7 +1,7 @@ --- id: upgrade title: HertzBeat 新版本更新指引 -sidebar_label: 版本更新指引 +sidebar_label: 版本更新指引 --- **Apache HertzBeat (incubating) 的发布版本列表** @@ -14,8 +14,6 @@ HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据 **升级前您需要保存备份好数据库的数据文件和监控模版文件** - - ### Docker部署方式的升级 1. 若使用了自定义监控模版 @@ -23,32 +21,26 @@ HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据 - `docker cp hertzbeat:/opt/hertzbeat/define ./define` - 然后在后续升级启动 docker 容器的时候需要挂载上这个 define 目录，`-v $(pwd)/define:/opt/hertzbeat/define` - `-v $(pwd)/define:/opt/hertzbeat/define` - -2. 若使用内置默认 H2 数据库 +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/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** +**HAVE FUN** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md index 7668cefcaf3..05355fe6559 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md @@ -1,7 +1,7 @@ --- id: victoria-metrics-init title: 依赖时序数据库服务VictoriaMetrics安装初始化 -sidebar_label: 使用VictoriaMetrics存储指标数据(推荐) +sidebar_label: 使用VictoriaMetrics存储指标数据(推荐) --- Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) @@ -11,21 +11,23 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) **注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** -**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** +**⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 +### 通过Docker方式安装VictoriaMetrics -### 通过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 +> 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 \ @@ -34,16 +36,16 @@ $ docker run -d -p 8428:8428 \ victoriametrics/victoria-metrics:v1.95.1 ``` - `-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 - 使用```$ docker ps```查看数据库是否启动成功 +`-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 +使用```$ docker ps```查看数据库是否启动成功 -3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 +3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 配置HertzBeat的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 -**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** +**修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** ```yaml warehouse: @@ -61,8 +63,9 @@ warehouse: 4. 重启 HertzBeat -### 常见问题 +### 常见问题 1. 时序数据库是否都需要配置，能不能都用 + > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，但会影响历史图表数据和存储时长等。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md index 55d89c73cba..219620a230c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md @@ -4,27 +4,27 @@ title: 监控模版中心 sidebar_label: 监控模版 --- -> Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 - +> Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ -这是它的架构原理: +这是它的架构原理: ![hertzBeat](/img/docs/hertzbeat-arch.png) -**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版，用户可以导入这些模版到hertzbeat系统中，使其支持对应类型的监控，非常方便！** +**我们将所有监控采集类型(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)
+ 👉 [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)
@@ -32,7 +32,7 @@ sidebar_label: 监控模版  👉 [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)
@@ -49,7 +49,7 @@ sidebar_label: 监控模版  👉 [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)
@@ -64,7 +64,6 @@ sidebar_label: 监控模版  👉 [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)
@@ -78,13 +77,12 @@ sidebar_label: 监控模版  👉 [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)
diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md index cb8cec5b7aa..9ccb0e9454b 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md @@ -4,14 +4,16 @@ 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. +> 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** +**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. +### HertzBeat data format specification + +Note⚠️ The response data is JSON format. Single layer format ：key-value + ```json { "metricName1": "metricValue", @@ -20,7 +22,9 @@ Single layer format ：key-value "metricName4": "metricValue" } ``` + Multilayer format：Set key value in the array + ```json [ { @@ -37,9 +41,11 @@ Multilayer format：Set key value in the array } ] ``` + eg： -Query the CPU information of the custom system. The exposed interface is `/metrics/cpu`. We need `hostname,core,useage` Metric. -If there is only one virtual machine, its single-layer format is : +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", @@ -49,7 +55,9 @@ If there is only one virtual machine, its single-layer format is : "runningTime": 100 } ``` -If there are multiple virtual machines, the multilayer format is: : + +If there are multiple virtual machines, the multilayer format is: : + ```json [ { @@ -76,7 +84,7 @@ If there are multiple virtual machines, the multilayer format is: : ] ``` -**The corresponding monitoring template yml can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -146,3 +154,4 @@ metrics: # Hertzbeat default parsing is used here parseType: default ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md index d2107ffba96..43d0b6cd9c9 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md @@ -8,12 +8,10 @@ Through this tutorial, we describe step by step how to add a monitoring type bas 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, @@ -22,6 +20,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz } ``` + 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: @@ -63,16 +62,13 @@ As above, usually our background API interface will design such a general return **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 @@ -200,39 +196,31 @@ metrics: **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. +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md index f5396e3dde6..edd713acad9 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md @@ -22,6 +22,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz "identifier": "admin" } ``` + **The response structure data is as follows**: ```json @@ -40,11 +41,9 @@ Before reading this tutorial, we hope that you are familiar with how to customiz **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 @@ -214,15 +213,12 @@ metrics: ![](/img/docs/advanced/extend-http-example-5.png) - ** After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page. ** ![](/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** @@ -334,8 +330,7 @@ metrics: # 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 @@ -385,13 +380,13 @@ metrics: > 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. +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md index 772c96d20d3..86a49c06756 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md @@ -3,16 +3,18 @@ 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. +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** -**Use the JsonPath script to parse the response data into data that conforms to the data structure rules specified by HertzBeat** +#### JsonPath Operator -#### JsonPath Operator -[JSONPath online verification](https://www.jsonpath.cn) +[JSONPath online verification](https://www.jsonpath.cn) -| JSONPATH | Help description | +| JSONPATH | Help description | |------------------|----------------------------------------------------------------------------------------| | $ | Root object or element | | @ | Current object or element | @@ -25,8 +27,10 @@ Note⚠️ The response data is JSON format. | ?() | Filter (script) expression | | () | Script Expression | -#### HertzBeat data format specification +#### HertzBeat data format specification + Single layer format ：key-value + ```json { "metricName1": "metricValue", @@ -35,7 +39,9 @@ Single layer format ：key-value "metricName4": "metricValue" } ``` + Multilayer format：Set key value in the array + ```json [ { @@ -56,7 +62,8 @@ Multilayer format：Set key value in the array #### Example Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. -The raw data returned by the interface is as follows： +The raw data returned by the interface is as follows： + ```json { "firstName": "John", @@ -80,7 +87,8 @@ The raw data returned by the interface is as follows： } ``` -We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： +We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： + ```json [ { @@ -93,9 +101,10 @@ We use the jsonpath script to parse, and the corresponding script is: `$.number[ } ] ``` + This data structure conforms to the data format specification of HertzBeat, and the Metric `type,num` is successfully extracted. -**The corresponding monitoring template yml can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -163,3 +172,4 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http.md index a69b54e84d0..5c4735bd2cd 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http.md @@ -1,35 +1,33 @@ --- id: extend-http title: HTTP Protocol Custom Monitoring -sidebar_label: 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 +> 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 +### 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. +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) - +**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 +### 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. +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. @@ -204,3 +202,4 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md index 1748e372961..09e2c031e0c 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md @@ -1,68 +1,73 @@ --- id: extend-jdbc title: JDBC Protocol Custom Monitoring -sidebar_label: 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**】 +> 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 +### 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. +#### **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. +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. + +> 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. +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. + +> 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： +SQL response data： -| key | value | -|---------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +| 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 +### 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. - +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 @@ -236,3 +241,4 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md b/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md index 2c051dc9c2a..d6d9efdb651 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md @@ -1,12 +1,14 @@ --- id: extend-jmx title: JMX Protocol Custom Monitoring -sidebar_label: 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. @@ -15,25 +17,24 @@ It can be seen from the process that we define a monitoring type of JMX protocol 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 +### 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 @@ -191,3 +192,4 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-point.md b/home/versioned_docs/version-v1.4.x/advanced/extend-point.md index eba1811e4fc..314e3f1affa 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-point.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-point.md @@ -1,31 +1,29 @@ --- id: extend-point title: Custom Monitoring -sidebar_label: 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 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. -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** +### 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 +### 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 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** - +**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 @@ -132,3 +130,4 @@ metrics: parseType: website ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md b/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md index c97aea1f766..b3bb9173c87 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md @@ -1,23 +1,22 @@ --- id: extend-snmp title: SNMP Protocol Custom Monitoring -sidebar_label: 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** @@ -25,18 +24,17 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p ![](/img/docs/advanced/extend-point-1.png) ------- + Configuration usages of the monitoring templates yml are detailed below. ### 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 @@ -171,3 +169,4 @@ metrics: processes: 1.3.6.1.2.1.25.1.6.0 location: 1.3.6.1.2.1.1.6.0 ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md index 1567c9a762e..6db1d4a5675 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md @@ -1,21 +1,25 @@ --- id: extend-ssh title: SSH Protocol Custom Monitoring -sidebar_label: 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**】 +> 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 +### 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. +#### **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 @@ -23,31 +27,37 @@ 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： +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` +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 +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. + +> 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： +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： +Console response is： + ```shell total used free buff_cache available 7962 4066 331 3564 3592 @@ -60,18 +70,17 @@ Here the Metric field and the response data can be mapped into collected data on **HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** ------- + Configuration usages of the monitoring templates yml are detailed below. ### 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 @@ -203,3 +212,4 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` + diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md b/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md index f3b93341874..363cb51e089 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md @@ -8,12 +8,10 @@ Through this tutorial, we describe step by step how to customize and adapt a mon 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, @@ -22,6 +20,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz } ``` + 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: @@ -58,17 +57,14 @@ As above, usually our background API interface will design such a general return **This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** - ### 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** @@ -199,32 +195,24 @@ metrics: **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! diff --git a/home/versioned_docs/version-v1.4.x/help/activemq.md b/home/versioned_docs/version-v1.4.x/help/activemq.md index 52e3090fde2..f24bc37fbbb 100644 --- a/home/versioned_docs/version-v1.4.x/help/activemq.md +++ b/home/versioned_docs/version-v1.4.x/help/activemq.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] **Use Protocol: JMX** -### Pre-monitoring Operations +### Pre-monitoring Operations > You need to enable the `JMX` service on ActiveMQ, HertzBeat uses the JMX protocol to collect metrics from ActiveMQ. @@ -26,6 +26,7 @@ keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] 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" @@ -36,6 +37,7 @@ 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" @@ -52,7 +54,7 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" ### Configuration parameters -| Parameter name | Parameter help description | +| 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. | @@ -64,82 +66,81 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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 +### Collect Metrics #### metrics: broker -| Metric Name | Unit | Description | +| Metric Name | Unit | Description | |-------------------------|------|-----------------------------------------------------------------------| -| BrokerName | None | The name of the broker. | -| BrokerVersion | None | The version of the broker. | -| Uptime | None | Uptime of the broker. | +| 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. | +| 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 | - +| 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 | +| 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 | - +| 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 | +| 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 index 5323ede8110..52367155d89 100644 --- a/home/versioned_docs/version-v1.4.x/help/airflow.md +++ b/home/versioned_docs/version-v1.4.x/help/airflow.md @@ -9,33 +9,31 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：airflow_health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | -------------------- | -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|------------------| +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | #### 指标集合：airflow_version -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | --------------- | -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------| +| 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 index e727fec4771..45ab7d791d3 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_console.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_console.md @@ -6,13 +6,13 @@ 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. \ No newline at end of file +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 index fb63d52aa48..b86ed662940 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md @@ -5,15 +5,15 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by DingDing robot. -### Operation steps +### 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. +> 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) +![email](/img/docs/help/alert-notice-8.png) 2. **【Save access_token value of the WebHook address of the robot】** @@ -24,18 +24,18 @@ keywords: [open source monitoring tool, open source alerter, open source DingDin ![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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### DingDing robot common issues -### DingDing robot common issues +1. DingDing group did not receive the robot alarm notification. -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! +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 index 8dfdca384fa..7aa565c0acf 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_discord.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_discord.md @@ -45,7 +45,6 @@ keywords: [open source monitoring tool, open source alerter, open source Discord ![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]** @@ -58,13 +57,12 @@ keywords: [open source monitoring tool, open source alerter, open source Discord ![email](/img/docs/help/alert-notice-policy.png) +### Discord Bot Notification FAQ -### Discord Bot Notification FAQ - -1. Discord doesn't receive bot alert notifications +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 +> Please check whether the bot is properly authorized by the Discord chat server Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_email.md b/home/versioned_docs/version-v1.4.x/help/alert_email.md index 353ae4673fe..fb6dc7fa571 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_email.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_email.md @@ -5,34 +5,35 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by email. -### Operation steps +### Operation steps -1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** +1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** -![email](/img/docs/help/alert-notice-1.png) +![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-2.png) -![email](/img/docs/help/alert-notice-3.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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### Email notification common issues -### Email notification common issues +1. Hertzbeat deployed on its own intranet cannot receive email notifications -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 +> 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 -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. +> 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 index f9e072e436a..1d5d41a15bc 100644 --- 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 @@ -5,30 +5,30 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by enterprise WeChat App. -### Operation steps +### 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) +![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】** +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.** +> **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) +![email](/img/docs/help/alert-wechat-3.jpg) +### Enterprise WeChat App common issues -### Enterprise WeChat App common issues +1. Enterprise WeChat App did not receive the alarm notification. -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! +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 index 56606012021..8f7e9391001 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_feishu.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_feishu.md @@ -5,30 +5,30 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by FeiShu robot. -### Operation steps +### 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】** +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` +> 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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### FeiShu robot notification common issues -### FeiShu robot notification common issues +1. FeiShu group did not receive the robot alarm notification. -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. +> 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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_slack.md b/home/versioned_docs/version-v1.4.x/help/alert_slack.md index 2540a27451d..5148432fe8b 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_slack.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_slack.md @@ -25,12 +25,11 @@ Refer to the official website document [Sending messages using Incoming Webhooks ![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 +> 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_telegram.md b/home/versioned_docs/version-v1.4.x/help/alert_telegram.md index 1fbe4f0ae7e..cb60f266778 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_telegram.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_telegram.md @@ -54,13 +54,12 @@ Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token ![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 +> UserId should be the UserId of the recipient of the message Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_threshold.md b/home/versioned_docs/version-v1.4.x/help/alert_threshold.md index 893f674164d..c62dee02704 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_threshold.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_threshold.md @@ -1,18 +1,18 @@ --- id: alert_threshold title: Threshold alarm configuration -sidebar_label: 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. +> 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 +### Operation steps -1. **【Alarm configuration】->【Add new threshold】-> 【Confirm after configuration】** +1. **【Alarm configuration】->【Add new threshold】-> 【Confirm after configuration】** -![threshold](/img/docs/help/alert-threshold-1.png) +![threshold](/img/docs/help/alert-threshold-1.png) -As shown above： +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) @@ -20,17 +20,17 @@ As shown above： **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. +**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】** +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.**。 +> **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-2.png) -![threshold](/img/docs/help/alert-threshold-3.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】.** +**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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md b/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md index e211514cad2..493d7fbce15 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md @@ -1,12 +1,12 @@ --- id: alert_threshold_expr title: Threshold trigger expression -sidebar_label: 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. +> 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 +#### Operators supported by expressions ``` equals(str1,str2) @@ -24,26 +24,27 @@ 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 != +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. +#### 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` +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 +#### Expression setting case 1. Website monitoring -> Trigger alarm when the response time is greater than or equal to 400ms -`responseTime>=400` + `responseTime>=400` 2. API monitoring -> Trigger alarm when the response time is greater than 3000ms -`responseTime>3000` + `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` + `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` + `threads_running>7` -Other issues can be fed back through the communication group ISSUE! +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 index adc1b6f12f8..d1741d71481 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_webhook.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_webhook.md @@ -5,23 +5,24 @@ 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. +> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient. -### Operation steps +### Operation steps -1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】** +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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) -### WebHook callback POST body BODY content +### WebHook callback POST body BODY content + +Content format：JSON -Content format：JSON ```json { "alarmId": 76456, @@ -43,24 +44,23 @@ Content format：JSON } ``` -| | | -|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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} | - +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 -### Webhook notification common issues +1. WebHook callback did not take effect -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_wework.md b/home/versioned_docs/version-v1.4.x/help/alert_wework.md index e862fae7ddf..ca14d5615fa 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_wework.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_wework.md @@ -5,34 +5,34 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by enterprise Wechat robot. -### Operation steps +### Operation steps -1. **【Enterprise Wechat】-> 【Group settings】-> 【Group robot】-> 【Add new robot】-> 【Set robot name and avatar】-> 【Copy its webhook address after adding successfully】** +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) +![email](/img/docs/help/alert-notice-6.jpg) -2. **【Save the key value of the WebHook address of the robot】** +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` +> 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】** +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】** +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) +> **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. +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. +> Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/api.md b/home/versioned_docs/version-v1.4.x/help/api.md index 8411dbad59e..136dd081926 100644 --- a/home/versioned_docs/version-v1.4.x/help/api.md +++ b/home/versioned_docs/version-v1.4.x/help/api.md @@ -5,31 +5,31 @@ 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. +> 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 | +| 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 +### Collection Metric -#### Metric set：summary +#### Metric set：summary -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| responseTime | ms | Website response time | +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | diff --git a/home/versioned_docs/version-v1.4.x/help/centos.md b/home/versioned_docs/version-v1.4.x/help/centos.md index 2a6ad2b0a6d..60b770ebf96 100644 --- a/home/versioned_docs/version-v1.4.x/help/centos.md +++ b/home/versioned_docs/version-v1.4.x/help/centos.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source os monitoring tool, monitori ### 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 | +| 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 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 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 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 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 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 | +| 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 index 91b032fdf54..82159bf2408 100644 --- a/home/versioned_docs/version-v1.4.x/help/dm.md +++ b/home/versioned_docs/version-v1.4.x/help/dm.md @@ -9,41 +9,41 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | +| 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 index fdd3098ce55..0e3a1f0b428 100644 --- a/home/versioned_docs/version-v1.4.x/help/docker.md +++ b/home/versioned_docs/version-v1.4.x/help/docker.md @@ -7,7 +7,6 @@ keywords: [open source monitoring tool, open source docker monitoring tool, moni > 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. @@ -31,7 +30,7 @@ This is equivalent to the **2375** port that is open to the outside world. Of co ```shell systemctl daemon-reload systemctl restart docker -```` +``` **Note: Remember to open the `2375` port number in the server console. ** @@ -42,65 +41,62 @@ 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 | +| 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 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 | +| 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 | +| 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 index 2bc212ef3fb..8dcde7b549b 100644 --- a/home/versioned_docs/version-v1.4.x/help/doris_be.md +++ b/home/versioned_docs/version-v1.4.x/help/doris_be.md @@ -9,162 +9,163 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8040 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| 数据库名称 | 数据库实例名称，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8040 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| 数据库名称 | 数据库实例名称，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：doris_be_load_channel_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| value | 无 | 当前打开的 load channel 个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------------| +| value | 无 | 当前打开的 load channel 个数 | #### 指标集合：doris_be_memtable_flush_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| value | 无 | memtable写入磁盘的个数累计值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | memtable写入磁盘的个数累计值 | #### 指标集合：doris_be_plan_fragment_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------- | -| value | 无 | 当前已接收的 fragment instance 的数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------| +| value | 无 | 当前已接收的 fragment instance 的数量 | #### 指标集合：doris_be_process_thread_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------- | -| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | #### 指标集合：doris_be_query_scan_rows -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------------------------------------------| +| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | #### 指标集合：doris_be_result_buffer_block_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------- | -| value | 无 | 当前查询结果缓存中的 query 个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 当前查询结果缓存中的 query 个数 | #### 指标集合：doris_be_send_batch_thread_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------------- | -| value | 无 | 导入时用于发送数据包的线程池的排队个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 导入时用于发送数据包的线程池的排队个数 | #### 指标集合：doris_be_tablet_base_max_compaction_score -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------- | -| value | 无 | 当前最大的 Base Compaction Score | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------------------| +| value | 无 | 当前最大的 Base Compaction Score | #### 指标集合：doris_be_timeout_canceled_fragment_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------------------- | -| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------------| +| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | #### 指标集合：doris_be_load_rows -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------- | -| value | 无 | 通过 tablet sink 发送的行数累计 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------| +| value | 无 | 通过 tablet sink 发送的行数累计 | #### 指标集合：doris_be_all_rowsets_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------- | -| value | 无 | 当前所有 rowset 的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 当前所有 rowset 的个数 | #### 指标集合：doris_be_all_segments_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------- | -| value | 无 | 当前所有 segment 的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| value | 无 | 当前所有 segment 的个数 | #### 指标集合：doris_be_heavy_work_max_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------ | -| value | 无 | brpc heavy线程池线程个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | brpc heavy线程池线程个数 | #### 指标集合：doris_be_light_work_max_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------ | -| value | 无 | brpc light线程池线程个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | brpc light线程池线程个数 | #### 指标集合：doris_be_heavy_work_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------------- | -| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | #### 指标集合：doris_be_light_work_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------------- | -| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | #### 指标集合：doris_be_heavy_work_active_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------- | -| value | 无 | brpc heavy线程池活跃线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | brpc heavy线程池活跃线程数 | #### 指标集合：doris_be_light_work_active_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------- | -| value | 无 | brpc light线程池活跃线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | brpc light线程池活跃线程数 | #### 指标集合：doris_be_compaction_bytes_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------------------------- | -| base | 字节 | Base Compaction 的数据量累计 | -| cumulative | 字节 | Cumulative Compaction 的数据量累计 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|------------------------------| +| base | 字节 | Base Compaction 的数据量累计 | +| cumulative | 字节 | Cumulative Compaction 的数据量累计 | #### 指标集合：doris_be_disks_avail_capacity -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------- | -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------| +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | #### 指标集合：doris_be_disks_total_capacity -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------- | -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------| +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | #### 指标集合：doris_be_local_bytes_read_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------- | -| value | 字节 | 由 `LocalFileReader` 读取的字节数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------| +| value | 字节 | 由 `LocalFileReader` 读取的字节数 | #### 指标集合：doris_be_local_bytes_written_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------- | -| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------| +| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | #### 指标集合：doris_be_memory_allocated_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------------------------- | -| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------| +| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | + diff --git a/home/versioned_docs/version-v1.4.x/help/doris_fe.md b/home/versioned_docs/version-v1.4.x/help/doris_fe.md index fc55fd25b65..67c4de34042 100644 --- a/home/versioned_docs/version-v1.4.x/help/doris_fe.md +++ b/home/versioned_docs/version-v1.4.x/help/doris_fe.md @@ -9,119 +9,119 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8030 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| 数据库名称 | 数据库实例名称，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8030 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| 数据库名称 | 数据库实例名称，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：doris_fe_connection_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------- | -| value | 无 | 当前FE的MySQL端口连接数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 当前FE的MySQL端口连接数 | #### 指标集合：doris_fe_edit_log_clean 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| success | 无 | 清理历史元数据日志成功的次数 | -| failed | 无 | 清理历史元数据日志失败的次数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| success | 无 | 清理历史元数据日志成功的次数 | +| failed | 无 | 清理历史元数据日志失败的次数 | #### 指标集合：doris_fe_edit_log -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------------- | -------- | ------------------------ | -| write | 无 | 元数据日志写入次数的计数 | -| read | 无 | 元数据日志读取次数的计数 | -| current | 无 | 元数据日志当前数量 | -| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | -| current_bytes | 字节 | 元数据日志当前值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|--------------| +| write | 无 | 元数据日志写入次数的计数 | +| read | 无 | 元数据日志读取次数的计数 | +| current | 无 | 元数据日志当前数量 | +| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | +| current_bytes | 字节 | 元数据日志当前值 | #### 指标集合：doris_fe_image_clean 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------- | -| success | 无 | 清理历史元数据镜像文件成功的次数 | -| failed | 无 | 清理历史元数据镜像文件失败的次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|------------------| +| success | 无 | 清理历史元数据镜像文件成功的次数 | +| failed | 无 | 清理历史元数据镜像文件失败的次数 | #### 指标集合：doris_fe_image_write 不应失败，如失败，需人工介入 -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| success | 无 | 生成元数据镜像文件成功的次数 | -| failed | 无 | 生成元数据镜像文件失败的次数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|----------------| +| success | 无 | 生成元数据镜像文件成功的次数 | +| failed | 无 | 生成元数据镜像文件失败的次数 | #### 指标集合：doris_fe_query_err -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------- | -| value | 无 | 错误查询的累积值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------| +| value | 无 | 错误查询的累积值 | #### 指标集合：doris_fe_max_journal_id -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------------------------------------------------------------------------------------| +| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE，则是当前写入的最大ID，如果是非Master FE，则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | #### 指标集合：doris_fe_max_tablet_compaction_score -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------------------------------------------------| +| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score，以判断是否过高。如过高则可能出现查询或写入延迟 | #### 指标集合：doris_fe_qps -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------ | -| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 当前FE每秒查询数量（仅统计查询请求） | #### 指标集合：doris_fe_query_err_rate -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------- | -| value | 无 | 每秒错误查询数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------| +| value | 无 | 每秒错误查询数 | #### 指标集合：doris_fe_report_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------------------------------| +| value | 无 | BE的各种定期汇报任务在FE端的队列长度，该值反映了汇报任务在 Master FE 节点上的阻塞程度，数值越大，表示FE处理能力不足 | #### 指标集合：doris_fe_rps -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------------------------- | -| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------| +| value | 无 | 当前FE每秒请求数量（包含查询以及其他各类语句） | #### 指标集合：doris_fe_scheduled_tablet_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------------------------------------------------------| +| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本，该数值可以反映当前集群，正在迁移的 tablet 数量。如果长时间有值，说明集群不稳定 | #### 指标集合：doris_fe_txn_status 可以观测各个状态下导入事务的数量，来判断是否有堆积 -| 指标名称 | 指标单位 | 指标帮助描述 | -| --------- | -------- | ------------- | -| unknown | 无 | 未知 | -| prepare | 无 | 准备中 | -| committed | 无 | 已提交 | -| visible | 无 | 可见 | -| aborted | 无 | 已中止/已撤销 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| 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 index 7418e17cc1b..fd36206bc6e 100644 --- a/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md +++ b/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md @@ -24,6 +24,7 @@ management: exposure: include: '*' ``` + Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has response json data as follows: ```json @@ -60,7 +61,6 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo 3. Add DynamicTp monitoring under HertzBeat middleware monitoring - ### Configuration parameters | Parameter name | Parameter help description | @@ -78,24 +78,25 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo #### 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 | +| 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 index 3246fa31d82..6145f238bdc 100644 --- a/home/versioned_docs/version-v1.4.x/help/fullsite.md +++ b/home/versioned_docs/version-v1.4.x/help/fullsite.md @@ -7,28 +7,29 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon > 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. +> Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. -### Configuration parameter +### 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 | +| 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 +### Collection Metric -#### Metric set：summary +#### 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 | -| 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 index cabcbe69506..ee506b0d6cd 100644 --- a/home/versioned_docs/version-v1.4.x/help/guide.md +++ b/home/versioned_docs/version-v1.4.x/help/guide.md @@ -5,25 +5,25 @@ sidebar_label: Help Center --- > Hertzbeat - An open source, real-time monitoring tool with custom-monitor and agentLess. -> Help documents and auxiliary information during use +> 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 +### Application service monitoring - 👉 [Website monitoring](website)
- 👉 [HTTP API](api)
- 👉 [PING Connectivity](ping)
- 👉 [Port availability](port)
+ 👉 [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 +### Database monitoring  👉 [MYSQL database monitoring](mysql)
 👉 [MariaDB database monitoring](mariadb)
@@ -34,7 +34,7 @@ sidebar_label: Help Center  👉 [OpenGauss database monitoring](opengauss)
 👉 [IoTDB database monitoring](iotdb)
-### Operating system monitoring +### Operating system monitoring  👉 [Linux operating system monitoring](linux)
 👉 [Windows operating system monitoring](windows)
@@ -59,34 +59,33 @@ sidebar_label: Help Center *** -## 💡 Alarm service +## 💡 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 +### Alarm center > The triggered alarm information center provides query and filtering of alarm deletion, alarm processing, mark unprocessed, alarm level status, etc. -### Alarm configuration +### 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) +More details see 👉 [threshold alarm](alert_threshold)
+   👉 [Threshold expression](alert_threshold_expr) -### Alarm notification +### 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. - +> 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 WebHook Notification](alert_webhook)
 👉 [Configure enterprise WeChat Robot Notification](alert_wework)
- 👉 [Configure DingDing Robot Notification](alert_dingtalk)
- 👉 [Configure FeiShu Robot Notification](alert_feishu)
+ 👉 [Configure DingDing Robot Notification](alert_dingtalk)
+ 👉 [Configure FeiShu Robot Notification](alert_feishu)
diff --git a/home/versioned_docs/version-v1.4.x/help/hadoop.md b/home/versioned_docs/version-v1.4.x/help/hadoop.md index f0a458ecc9f..56f19472277 100644 --- a/home/versioned_docs/version-v1.4.x/help/hadoop.md +++ b/home/versioned_docs/version-v1.4.x/help/hadoop.md @@ -11,9 +11,10 @@ keywords: [Open Source Monitoring System, Open Source Java Monitoring, Hadoop JV ### 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. +> 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: @@ -31,12 +32,12 @@ export HADOOP_OPTS= "$HADOOP_OPTS -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. +- 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 | +| 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 | @@ -70,16 +71,15 @@ export HADOOP_OPTS= "$HADOOP_OPTS #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -88,4 +88,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/hive.md b/home/versioned_docs/version-v1.4.x/help/hive.md index ec0d7dee398..806969c2e7c 100644 --- a/home/versioned_docs/version-v1.4.x/help/hive.md +++ b/home/versioned_docs/version-v1.4.x/help/hive.md @@ -16,6 +16,7 @@ If you want to monitor information in `Apache Hive` with this monitoring type, y ```shell hive --service metastore & ``` + **2. Enable hive server2:** ```shell @@ -24,55 +25,53 @@ 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 | +| 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 | +| 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 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 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 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. | +| 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. | - - +| used | MB | The amount of memory currently being used by the memory pool. | diff --git a/home/versioned_docs/version-v1.4.x/help/iotdb.md b/home/versioned_docs/version-v1.4.x/help/iotdb.md index 0e4dcad9912..bec827feb73 100644 --- a/home/versioned_docs/version-v1.4.x/help/iotdb.md +++ b/home/versioned_docs/version-v1.4.x/help/iotdb.md @@ -61,33 +61,33 @@ predefinedMetrics: #### 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 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 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 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 | +| 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 @@ -114,7 +114,8 @@ predefinedMetrics: #### Metric collection: thrift_connections -| Metric Name | Metric Unit | Metric Help Description | -|-------|------|-------------| -| name | None | name | -| connection | none | thrift current connection number | +| 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 index 40fd7848f64..6e20f392661 100644 --- a/home/versioned_docs/version-v1.4.x/help/issue.md +++ b/home/versioned_docs/version-v1.4.x/help/issue.md @@ -1,52 +1,63 @@ --- id: issue title: Common issues -sidebar_label: Common issues +sidebar_label: Common issues --- -### Monitoring 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 +1. **Page feedback：monitor.host: Monitoring Host must be ipv4, ipv6 or domain name** -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) +> 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 hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。 + > The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened. > When you install HertzBeat via DockerDocker root is enabled by default. No such problem. -> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address 4. If the history chart on the monitoring page is not displayed，popup [please configure dependency service on TDengine time series database] + > As shown in the popup window，the premise of history chart display is that you need install and configure hertzbeat's dependency service - TDengine database. -> Installation and initialization this database refers to [TDengine Installation and Initialization](../start/tdengine-init). +> Installation and initialization this database refers to [TDengine Installation and Initialization](../start/tdengine-init). -### Docker Deployment common issues +### Docker Deployment common issues 1. **MYSQL, TDENGINE and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** -The problems lies in Docker container failed to visit and connect localhost port. Beacuse the docker default network mode is Bridge mode which can't access loacl machine through localhost. + The problems lies in Docker container failed to visit and connect localhost port. 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 .....` +> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy，visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issuess： + Please refer to the following points to troubleshoot 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. +> 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** -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. +> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. ### Package Deployment common issues 1. **According to the process deploy，visit http://ip:1157/ no interface** 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. +> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. + diff --git a/home/versioned_docs/version-v1.4.x/help/jetty.md b/home/versioned_docs/version-v1.4.x/help/jetty.md index 3e5230aa9d0..6e069553dba 100644 --- a/home/versioned_docs/version-v1.4.x/help/jetty.md +++ b/home/versioned_docs/version-v1.4.x/help/jetty.md @@ -23,6 +23,7 @@ keywords: [open source monitoring tool, open source jetty web server monitoring 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. @@ -50,7 +51,7 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -73,19 +74,17 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` | max | kb | max size | | used | kb | used size | - #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | diff --git a/home/versioned_docs/version-v1.4.x/help/jvm.md b/home/versioned_docs/version-v1.4.x/help/jvm.md index 95b1545fffc..3b47e0e7a8a 100644 --- a/home/versioned_docs/version-v1.4.x/help/jvm.md +++ b/home/versioned_docs/version-v1.4.x/help/jvm.md @@ -24,7 +24,7 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -58,16 +58,15 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -76,4 +75,3 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/kafka.md b/home/versioned_docs/version-v1.4.x/help/kafka.md index 067cabef0e9..f86913733b1 100644 --- a/home/versioned_docs/version-v1.4.x/help/kafka.md +++ b/home/versioned_docs/version-v1.4.x/help/kafka.md @@ -27,70 +27,64 @@ 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 | +| 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 | - +| 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 | +| 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 | - +| 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 | +| 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 | - - - +| 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 index 8e10896c6d1..45adda576fc 100644 --- a/home/versioned_docs/version-v1.4.x/help/kubernetes.md +++ b/home/versioned_docs/version-v1.4.x/help/kubernetes.md @@ -28,6 +28,7 @@ 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 @@ -36,59 +37,60 @@ 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 | +| 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 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 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 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 | +| 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 index 05e3405ff6e..6c22028114c 100644 --- a/home/versioned_docs/version-v1.4.x/help/linux.md +++ b/home/versioned_docs/version-v1.4.x/help/linux.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source linux monitoring tool, monit ### 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 | +| 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 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 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 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 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 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 | +| 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 index e72668fe791..374e6e6a081 100644 --- a/home/versioned_docs/version-v1.4.x/help/mariadb.md +++ b/home/versioned_docs/version-v1.4.x/help/mariadb.md @@ -9,49 +9,46 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - - +| 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 index 5d89ce0977b..920da021e6b 100644 --- a/home/versioned_docs/version-v1.4.x/help/memcached.md +++ b/home/versioned_docs/version-v1.4.x/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 You need to use the stats command to view the parameters that your memcache can monitor ``` -### +### **1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. @@ -36,7 +36,7 @@ STAT version 1.4.15 ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -49,7 +49,7 @@ STAT version 1.4.15 #### Metrics Set：server_info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|---------------------------------------------------| | pid | | Memcache server process ID | | uptime | s | The number of seconds the server has been running | @@ -66,4 +66,5 @@ STAT version 1.4.15 | cmd_set | | Set command request count | | cmd_flush | | Flush command request count | | get_misses | | Get command misses | -| delete_misses | | Delete command misses | \ No newline at end of file +| delete_misses | | Delete command misses | + diff --git a/home/versioned_docs/version-v1.4.x/help/mysql.md b/home/versioned_docs/version-v1.4.x/help/mysql.md index 3f07be99380..dca64b3f9f0 100644 --- a/home/versioned_docs/version-v1.4.x/help/mysql.md +++ b/home/versioned_docs/version-v1.4.x/help/mysql.md @@ -7,9 +7,9 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo > Collect and monitor the general performance Metrics of MySQL database. Support MYSQL5+. -### Configuration parameter +### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -27,31 +27,28 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo #### 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 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 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 | - - +| 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 index ae2cfb4683f..c23e39c14fe 100644 --- a/home/versioned_docs/version-v1.4.x/help/nebulagraph.md +++ b/home/versioned_docs/version-v1.4.x/help/nebulagraph.md @@ -14,7 +14,7 @@ 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.** @@ -36,7 +36,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -55,7 +55,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat Too many indicators, related links are as follows **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** -| Metric name | Metric unit | Metric help description | +| 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. | @@ -67,8 +67,9 @@ Too many indicators, related links are as follows Too many indicators, related links are as follows **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |----------------------------|-------------|-------------------------------------------------------------| | rocksdb.backup.read.bytes | | Number of bytes read during the RocksDB database backup. | | rocksdb.backup.write.bytes | | Number of bytes written during the RocksDB database backup. | | ... | | ... | + diff --git a/home/versioned_docs/version-v1.4.x/help/nginx.md b/home/versioned_docs/version-v1.4.x/help/nginx.md index 99bb389000c..f630e4d4d24 100644 --- a/home/versioned_docs/version-v1.4.x/help/nginx.md +++ b/home/versioned_docs/version-v1.4.x/help/nginx.md @@ -20,6 +20,7 @@ If you want to monitor information in 'Nginx' with this monitoring type, you nee ```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 @@ -50,6 +51,7 @@ server { } } ``` + 4. Reload Nginx ```shell @@ -107,14 +109,13 @@ nginx -s reload 4. Access `http://localhost/req-status` in the browser to view the Nginx monitoring status information. - **Refer Doc: https://github.com/zls0424/ngx_req_status** **⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -128,28 +129,27 @@ nginx -s reload #### 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 | +| 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 | - +| 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 index 5eca6c58e80..666f2a6b39a 100644 --- a/home/versioned_docs/version-v1.4.x/help/ntp.md +++ b/home/versioned_docs/version-v1.4.x/help/ntp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -23,7 +23,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito #### Metrics Set：summary -| Metric name | Metric unit | Metric help description | +| 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). | diff --git a/home/versioned_docs/version-v1.4.x/help/opengauss.md b/home/versioned_docs/version-v1.4.x/help/opengauss.md index 650882861e8..28171658951 100644 --- a/home/versioned_docs/version-v1.4.x/help/opengauss.md +++ b/home/versioned_docs/version-v1.4.x/help/opengauss.md @@ -5,54 +5,52 @@ 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. +> 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | diff --git a/home/versioned_docs/version-v1.4.x/help/oracle.md b/home/versioned_docs/version-v1.4.x/help/oracle.md index 5410e53decb..50d2f6422bc 100644 --- a/home/versioned_docs/version-v1.4.x/help/oracle.md +++ b/home/versioned_docs/version-v1.4.x/help/oracle.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -27,37 +27,38 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo #### 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 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 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 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 | +| 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 index c5603fdfbce..7c894f488ff 100644 --- a/home/versioned_docs/version-v1.4.x/help/ping.md +++ b/home/versioned_docs/version-v1.4.x/help/ping.md @@ -5,32 +5,33 @@ 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. +> 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 | +| 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 | - +| 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 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + diff --git a/home/versioned_docs/version-v1.4.x/help/pop3.md b/home/versioned_docs/version-v1.4.x/help/pop3.md index 822192ad66d..fffff2a494f 100644 --- a/home/versioned_docs/version-v1.4.x/help/pop3.md +++ b/home/versioned_docs/version-v1.4.x/help/pop3.md @@ -24,10 +24,9 @@ If you want to monitor information in 'POP3' with this monitoring type, you just 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 ``` - ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -42,9 +41,8 @@ If you want to monitor information in 'POP3' with this monitoring type, you just #### 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 | - +| 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 index ef5f659ad44..35ff99fcb57 100644 --- a/home/versioned_docs/version-v1.4.x/help/port.md +++ b/home/versioned_docs/version-v1.4.x/help/port.md @@ -7,25 +7,23 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito > 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 | +### 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 | - - +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | diff --git a/home/versioned_docs/version-v1.4.x/help/postgresql.md b/home/versioned_docs/version-v1.4.x/help/postgresql.md index de14f9d62eb..57834a713bd 100644 --- a/home/versioned_docs/version-v1.4.x/help/postgresql.md +++ b/home/versioned_docs/version-v1.4.x/help/postgresql.md @@ -9,50 +9,48 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | diff --git a/home/versioned_docs/version-v1.4.x/help/rabbitmq.md b/home/versioned_docs/version-v1.4.x/help/rabbitmq.md index 1bcd3ea5851..917ca63c3d3 100644 --- a/home/versioned_docs/version-v1.4.x/help/rabbitmq.md +++ b/home/versioned_docs/version-v1.4.x/help/rabbitmq.md @@ -7,7 +7,7 @@ keywords: [open source monitoring tool, open source rabbitmq monitoring tool, mo > Monitoring the running status of RabbitMQ message middleware, nodes, topics and other related metrics. -### Pre-monitoring Operations +### 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 @@ -24,7 +24,7 @@ rabbitmq-plugins enable rabbitmq_management ### Configuration parameters -| Parameter name | Parameter help description | +| 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. | @@ -40,7 +40,7 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: overview -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |--------------------|-------------|------------------------------------| | product_version | None | Product Version | | product_name | None | Product name | @@ -52,7 +52,7 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: object_totals -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |-------------|-------------|-----------------------------| | channels | none | total number of channels | | connections | none | total number of connections | @@ -62,24 +62,24 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: nodes -| Metric Name | Metric Unit | Metric Description | +| 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 | +| 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 | +| 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 | +| 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 | @@ -100,27 +100,27 @@ rabbitmq-plugins enable rabbitmq_management | queue_deleted | None | queue deleted num | | connection_closed | None | connection closed num | - #### metrics: queues -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------| -| name | None | The name of the queue with non-ASCII characters escaped as in C. | +| 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. | +| 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 | +| 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. | +| 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_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_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 | 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_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | + diff --git a/home/versioned_docs/version-v1.4.x/help/redis.md b/home/versioned_docs/version-v1.4.x/help/redis.md index dd9b304e1ce..58248fb0b45 100644 --- a/home/versioned_docs/version-v1.4.x/help/redis.md +++ b/home/versioned_docs/version-v1.4.x/help/redis.md @@ -2,244 +2,239 @@ id: redis title: 监控：REDIS数据库监控 sidebar_label: REDIS数据库 -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] --- > 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|-----------------------------------------------| +| 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 | 无 | 客户端超时表中的客户端数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|--------------------------------------------------------------------------------| +| 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 | 无 | 已延迟释放的对象数。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|----------|-----------------------------------------------------------------------------------------------| +| 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操作期间写入时复制内存的字节大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|--------|-----------------------------------------------------------------------------------------------------| +| 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 | 无 | 正在写入的线程数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|----------------------------------------------------| +| 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的大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-------------------------------------------------------------------------------------| +| 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 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|------------------------| +| 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 | 无 | | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-----------| +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | #### 指标集合：cluster -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------------------| +| 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命令的统计信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------------------------------------------------------------------------------------------------------------------------| +| 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 index 01523769c78..c7f12bbfaf0 100644 --- a/home/versioned_docs/version-v1.4.x/help/shenyu.md +++ b/home/versioned_docs/version-v1.4.x/help/shenyu.md @@ -5,27 +5,27 @@ 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. +> monitor ShenYu running status(JVM-related), include request response and other related metrics. -## Pre-monitoring operations +## Pre-monitoring operations -Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 +Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 -Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) +Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) -Two Steps Mainly: +Two Steps Mainly: -1. add metrics plugin dependency in gateway's pom.xml. +1. add metrics plugin dependency in gateway's pom.xml. ```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` -2. modify this config in shenyu gateway yaml. +2. modify this config in shenyu gateway yaml. ```yaml shenyu: @@ -57,75 +57,74 @@ Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond #### Index collection: shenyu_request_total -| Metric Name | Metric Unit | Metric Help Description | -| ----------- |------|-------------------| -| value | None | Collect all requests from ShenYu gateway | +| 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 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 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 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 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 | +|-------------|-------------|-------------------------| +| 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 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 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 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 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 | - +| 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 index 971de82c3e0..fedb17e0040 100644 --- a/home/versioned_docs/version-v1.4.x/help/smtp.md +++ b/home/versioned_docs/version-v1.4.x/help/smtp.md @@ -13,12 +13,11 @@ Determine whether the server is available through the hello command in SMTP > see https://datatracker.ietf.org/doc/html/rfc821#page-13 - **Protocol Use：SMTP** ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -33,7 +32,7 @@ Determine whether the server is available through the hello command in SMTP #### Metrics Set：summary -| Metric name | Metric unit | Metric help description | +| 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. | diff --git a/home/versioned_docs/version-v1.4.x/help/spark.md b/home/versioned_docs/version-v1.4.x/help/spark.md index 3d4b44828ea..41865300024 100644 --- a/home/versioned_docs/version-v1.4.x/help/spark.md +++ b/home/versioned_docs/version-v1.4.x/help/spark.md @@ -15,12 +15,9 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, Refer: https://spark.apache.org/docs/latest/spark-standalone.html - **监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** - - ## 第一步 **修改$SPARK_HOME/conf/spark-env.sh，添加以下语句：** @@ -36,8 +33,6 @@ export SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.manageme 语句中有$JMX_PORT，这个的值可以自定义，也可以获取一个随机数作为端口号。 如果端口自定义为一个具体的值，而 spark 的 Master 和其中之一的 Worker 在同一台机器上，会出现端口冲突的情况。 - - ## 第二步 **vim $SPARK_HOME/conf/metrics.properties 添加如下内容** @@ -50,10 +45,6 @@ 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设置监控端口，在有程序运行的情况下，此端口会被打开。** @@ -69,11 +60,9 @@ gement.jmxremote.port=8711 在spark的Master和Worker正常运行以及spark-submit提交了一个程序的情况下，可以从linux中查询出端口号码。 - - ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -107,16 +96,15 @@ gement.jmxremote.port=8711 #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -125,4 +113,3 @@ gement.jmxremote.port=8711 | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/spring_gateway.md b/home/versioned_docs/version-v1.4.x/help/spring_gateway.md index ae24228c222..66c5f0b4f29 100644 --- a/home/versioned_docs/version-v1.4.x/help/spring_gateway.md +++ b/home/versioned_docs/version-v1.4.x/help/spring_gateway.md @@ -19,6 +19,7 @@ If you want to monitor information in 'Spring Gateway' with this monitoring type spring-boot-starter-actuator ``` + **2. Modify the YML configuration exposure metric interface:** ```yaml @@ -35,56 +36,55 @@ management: ### 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 | +| 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 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 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 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 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 | - +| 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 index ca46530f77b..6452aff270e 100644 --- a/home/versioned_docs/version-v1.4.x/help/springboot2.md +++ b/home/versioned_docs/version-v1.4.x/help/springboot2.md @@ -19,6 +19,7 @@ If you want to monitor information in 'SpringBoot' with this monitoring type, yo spring-boot-starter-actuator ``` + **2. Modify the YML configuration exposure metric interface:** ```yaml @@ -29,7 +30,9 @@ management: 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 @@ -45,47 +48,49 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ } } ``` + ### 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 | +| 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 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 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 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 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 index cc12abf0d7e..71bd8ebdc83 100644 --- a/home/versioned_docs/version-v1.4.x/help/sqlserver.md +++ b/home/versioned_docs/version-v1.4.x/help/sqlserver.md @@ -9,51 +9,49 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-----------------|-------------|------------------------------| +| user_connection | none | Number of connected sessions | ### Common Problem @@ -61,10 +59,12 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo jdk version: jdk11 Description of the problem: SQL Server 2019 uses the SA user connection to report an error -Error message: +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) diff --git a/home/versioned_docs/version-v1.4.x/help/ssl_cert.md b/home/versioned_docs/version-v1.4.x/help/ssl_cert.md index 7265bd12a59..e7b60fc8a89 100644 --- a/home/versioned_docs/version-v1.4.x/help/ssl_cert.md +++ b/home/versioned_docs/version-v1.4.x/help/ssl_cert.md @@ -9,25 +9,26 @@ keywords: [open source monitoring tool, open source ssl cert monitoring tool, mo ### 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 | +| 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 | +| 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 index 8b35808ffc8..60591f85579 100644 --- a/home/versioned_docs/version-v1.4.x/help/tomcat.md +++ b/home/versioned_docs/version-v1.4.x/help/tomcat.md @@ -11,61 +11,60 @@ keywords: [open source monitoring tool, open source tomcat monitoring tool, moni ### 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 | +| 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 | +| 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 | +| 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 | - +| 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 | +| 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 +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 diff --git a/home/versioned_docs/version-v1.4.x/help/ubuntu.md b/home/versioned_docs/version-v1.4.x/help/ubuntu.md index e7d368c9ea3..8d3b65ce195 100644 --- a/home/versioned_docs/version-v1.4.x/help/ubuntu.md +++ b/home/versioned_docs/version-v1.4.x/help/ubuntu.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source linux ubuntu monitoring tool ### 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 | +| 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 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 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 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 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 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 | +| 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 index e227de0dd1f..afe86397c9e 100644 --- a/home/versioned_docs/version-v1.4.x/help/website.md +++ b/home/versioned_docs/version-v1.4.x/help/website.md @@ -5,25 +5,26 @@ 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. +> Monitor whether the website is available, response time and other Metrics. -### Configuration parameter +### 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 | +| 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 +### Collection Metric -#### Metric set：summary +#### Metric set：summary + +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| responseTime | ms | Website response time | diff --git a/home/versioned_docs/version-v1.4.x/help/windows.md b/home/versioned_docs/version-v1.4.x/help/windows.md index 82e36d23470..e4be2bd6d96 100644 --- a/home/versioned_docs/version-v1.4.x/help/windows.md +++ b/home/versioned_docs/version-v1.4.x/help/windows.md @@ -6,38 +6,39 @@ keywords: [open source monitoring tool, open source windows monitoring tool, mon --- > Collect and monitor the general performance Metrics of Windows operating system through SNMP protocol. -> Note⚠️ You need to start SNMP service for Windows server. +> 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) +[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 | +| 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 | +| 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 | +| 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 index b7a34f49eda..f14b0bb8273 100644 --- a/home/versioned_docs/version-v1.4.x/help/zookeeper.md +++ b/home/versioned_docs/version-v1.4.x/help/zookeeper.md @@ -10,10 +10,12 @@ keywords: [open source monitoring tool, open source zookeeper monitoring tool, m ### 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. + +> 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 @@ -28,73 +30,74 @@ Steps > 3.Restart service -```shell +```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 -``` +> +> ```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 | +| 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 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 | - +| 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 index 63a35e80ab9..60b8a623bf4 100644 --- a/home/versioned_docs/version-v1.4.x/introduce.md +++ b/home/versioned_docs/version-v1.4.x/introduce.md @@ -5,7 +5,7 @@ sidebar_label: Introduce slug: / --- -> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +> 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/) @@ -34,11 +34,9 @@ slug: / * 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. -> 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. @@ -51,7 +49,6 @@ Do you believe that users can just write a monitoring template on the UI page, c ![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**. @@ -99,7 +96,7 @@ Do you believe that users can just write a monitoring template on the UI page, c > 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. +> 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) @@ -107,12 +104,12 @@ Do you believe that users can just write a monitoring template on the UI page, c > 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 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`. +The principle of `HertzBeat` is to use different protocols to connect directly to the end system, and use the `PULL` form to pull the collected data, without the need for the user to deploy and install `Agent` | `Exporter` on the host of the end, etc. For example, monitoring the `linux operating system`. - For example, if you want to monitor `linux OS`, you can just input the IP port account password or key on `HertzBeat` side. -- For example, to monitor `linux OS`, just enter your ip/port account password or key in `HertzBeat`. +- For example, 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**. @@ -131,7 +128,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > Two locations, three centers, multi-cloud environments, multi-isolated networks, you may have heard of these scenarios. When there is a need for a unified monitoring system to monitor the IT resources of different isolated networks, this is where our Cloud Edge Collaboration comes in. In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance. -`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` 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) @@ -150,12 +147,11 @@ In an isolated network where multiple networks are not connected, we need to dep - 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.** @@ -273,7 +269,6 @@ Built-in support for monitoring types include: ![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. @@ -305,7 +300,6 @@ Built-in support for monitoring types include: ![hertzbeat](/img/home/9.png) - ----- **There's so much more to discover. Have Fun!** diff --git a/home/versioned_docs/version-v1.4.x/others/contact.md b/home/versioned_docs/version-v1.4.x/others/contact.md index 02d956093b4..9411e50d072 100644 --- a/home/versioned_docs/version-v1.4.x/others/contact.md +++ b/home/versioned_docs/version-v1.4.x/others/contact.md @@ -1,7 +1,7 @@ --- id: contact title: Join discussion -sidebar_label: 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. @@ -12,7 +12,6 @@ sidebar_label: Discussion [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 index 48c32ef703a..237eb63860e 100644 --- a/home/versioned_docs/version-v1.4.x/others/contributing.md +++ b/home/versioned_docs/version-v1.4.x/others/contributing.md @@ -1,7 +1,7 @@ --- id: contributing title: Contributing Guide -sidebar_label: Contributing Guide +sidebar_label: Contributing Guide --- > We are committed to maintaining a happy community that helps each other, welcome every contributor to join us! @@ -33,7 +33,6 @@ Even small corrections to typos are very welcome :) > 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 @@ -60,23 +59,31 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D 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. @@ -125,14 +132,15 @@ 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. +> - **[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. +> - **[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. +> - **[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. +> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** Provide web ui. > Angular Web UI. -![hertzBeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat/home/static/img/docs/hertzbeat-arch.svg) +![hertzBeat](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 index 83d15a5c4a3..64e248f5b2d 100644 --- a/home/versioned_docs/version-v1.4.x/others/design.md +++ b/home/versioned_docs/version-v1.4.x/others/design.md @@ -1,13 +1,13 @@ --- id: design title: Design Document -sidebar_label: Design Document +sidebar_label: Design Document --- -### HertzBeat Architecture +### HertzBeat Architecture -![architecture](https://cdn.jsdelivr.net/gh/apache/hertzbeat/home/static/img/docs/hertzbeat-arch.svg) +![architecture](https://cdn.jsdelivr.net/gh/apache/hertzbeat/home/static/img/docs/hertzbeat-arch.svg) -### TanCloud Architecture +### TanCloud Architecture -TanCloud is a SAAS cluster version based on HertzBeat, which adopts a multi-cluster and multi-tenant architecture model. +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 index 7e5793415a9..0ceca3e27d8 100644 --- a/home/versioned_docs/version-v1.4.x/others/developer.md +++ b/home/versioned_docs/version-v1.4.x/others/developer.md @@ -1,10 +1,10 @@ --- id: developer title: Contributors -sidebar_label: Contributors +sidebar_label: Contributors --- -## ✨ HertzBeat Members +## ✨ HertzBeat Members @@ -26,238 +26,235 @@ sidebar_label: Contributors
-cert - +cert ## ✨ HertzBeat Contributors -Thanks to these wonderful people, welcome to join us: [Contributor Guide](contributing) +Thanks to these wonderful people, welcome to join us: [Contributor Guide](contributing) -cert +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
📖
- + + +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 index cf6e7484db3..ab3dc5bf36a 100644 --- a/home/versioned_docs/version-v1.4.x/others/hertzbeat.md +++ b/home/versioned_docs/version-v1.4.x/others/hertzbeat.md @@ -1,10 +1,9 @@ --- id: hertzbeat title: HertzBeat 开源实时监控系统 -sidebar_label: HertzBeat 实时监控 +sidebar_label: HertzBeat 实时监控 --- - > 易用友好的开源实时监控告警系统，无需Agent，高性能集群，强大自定义监控能力。 ![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/web-monitor.svg) @@ -17,7 +16,6 @@ sidebar_label: HertzBeat 实时监控 ![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 的开源实时监控告警系统。 @@ -30,8 +28,7 @@ sidebar_label: HertzBeat 实时监控 - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式消息及时送达。 - -> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ---- @@ -42,12 +39,12 @@ sidebar_label: HertzBeat 实时监控 - 基于`Java+SpringBoot+TypeScript+Angular`主流技术栈构建，方便的二次开发。 - 但开源不等同于免费，基于HertzBeat二次开发需保留logo，名称，页面脚注，版权等。 -### 强大的监控模版 +### 强大的监控模版 -> 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 +> 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 HertzBeat 自身并没有去创造一种采集数据协议，让对端来适配它。而是充分使用了现有的生态，SNMP采集网络交换机路由器信息，JMX采集JAVA应用信息，JDBC规范采集数据集信息，SSH直连执行脚本获取回显信息，HTTP+(JsonPath | prometheus等)解析接口信息，IPMI采集服务器信息等等。 -HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标信息。 +HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标信息。 ![hertzbeat](/img/blog/multi-protocol.png) @@ -55,7 +52,6 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ![hertzbeat](/img/home/9.png) - ### 内置监控类型 **一款监控类型对应一个YML监控模版** @@ -87,26 +83,26 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 - 和更多自定义监控模版。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 -### 强大自定义功能 +### 强大自定义功能 > 由前面的**监控模版**介绍，大概清楚了 HertzBeat 拥有的强大自定义功能。 > 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 -> 模版里面包含各个协议的使用，指标别名转换，指标计算，单位转换等一系列功能，帮助用户能采集到自己想要的监控指标。 +> 模版里面包含各个协议的使用，指标别名转换，指标计算，单位转换等一系列功能，帮助用户能采集到自己想要的监控指标。 ![hertzbeat](/img/docs/custom-arch.png) -### 无需 Agent +### 无需 Agent > 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 agent 的安装部署调试了。 > 每台主机得装个 agent，为了监控不同应用中间件可能还得装几个对应的 agent，量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 -> agent 的版本是否与主应用兼容, agent 与主应用的通讯调试, agent 的同步升级等等等等，这些全是头大的点。 +> agent 的版本是否与主应用兼容, agent 与主应用的通讯调试, agent 的同步升级等等等等，这些全是头大的点。 HertzBeat 的原理就是使用不同的协议去直连对端系统，采集 PULL 的形式去拉取采集数据，无需用户在对端主机上部署安装 Agent | Exporter等。 比如监控 linux, 在 HertzBeat 端输入IP端口账户密码或密钥即可。 比如监控 mysql, 在 HertzBeat 端输入IP端口账户密码即可。 -**密码等敏感信息全链路加密** +**密码等敏感信息全链路加密** -### 高性能集群 +### 高性能集群 > 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 > 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 @@ -114,16 +110,16 @@ HertzBeat 的原理就是使用不同的协议去直连对端系统，采集 PUL ![hertzbeat](/img/docs/cluster-arch.png) -### 云边协同 +### 云边协同 > 支持部署边缘采集器集群，与主 HertzBeat 服务云边协同提升采集能力。 在多个网络不相通的隔离网络中，在以往的方案中我们需要在每个网络都部署一套监控系统，这导致数据不互通，管理部署维护都不方便。 -HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主 HertzBeat 服务统一调度管理展示。 +HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采集器，采集器在隔离网络内部进行监控任务采集，采集数据上报，由主 HertzBeat 服务统一调度管理展示。 ![hertzbeat](/img/docs/cluster-arch.png) -### 易用友好 +### 易用友好 > 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 > 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 @@ -131,15 +127,12 @@ HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采 > 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 > 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 - - ------ - +--- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ----- -## 即刻体验一波 +## 即刻体验一波 Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` 浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` @@ -148,7 +141,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 - HertzBeat 的用户管理统一由配置文件 `sureness.yml` 维护，用户可以通过修改此文件来新增删除修改用户信息，用户角色权限等。默认账户密码 admin/hertzbeat -![hertzbeat](/img/home/0.png) +![hertzbeat](/img/home/0.png) ### 概览页面 @@ -156,7 +149,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 - 展示当前注册的采集器集群状态，包括采集器的上线状态，监控任务，启动时间，IP地址，名称等。 - 下发展示了最近告警信息列表，告警级别分布情况，告警处理率情况。 -![hertzbeat](/img/home/1.png) +![hertzbeat](/img/home/1.png) ### 监控中心 @@ -194,7 +187,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 [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) +![hertzbeat](/img/home/2.png) ### 新增修改监控 @@ -211,9 +204,9 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 - 监控历史数据报告，以趋势图表的形式展示了当前监控数值类型的指标的历史值，支持查询小时，天，月的历史数据，支持配置页面刷新时间。 - ⚠️注意监控历史图表需配置外置时序数据库才能获取完整功能，时序数据库支持: IOTDB, TDengine, InfluxDB, GreptimeDB -![hertzbeat](/img/home/3.png) +![hertzbeat](/img/home/3.png) -![hertzbeat](/img/home/4.png) +![hertzbeat](/img/home/4.png) ### 告警中心 @@ -229,7 +222,7 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 - 阈值规则支持可视化页面配置或表达式规则配置，灵活性更高。 - 支持配置触发次数，告警级别，通知模版，关联指定监控等。 -![hertzbeat](/img/home/6.png) +![hertzbeat](/img/home/6.png) ![hertzbeat](/img/home/11.png) @@ -242,7 +235,6 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/13.png) - ### 告警静默 - 当通过阈值规则判断触发告警后，会进入到告警静默，告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默，此时间段不发送告警消息。 @@ -264,17 +256,16 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 ![hertzbeat](/img/home/17.png) -![hertzbeat](/img/home/8.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](/img/home/9.png) ------ +--- **`HertzBeat`更多强大的功能欢迎使用探索。Have Fun!** diff --git a/home/versioned_docs/version-v1.4.x/others/huaweicloud.md b/home/versioned_docs/version-v1.4.x/others/huaweicloud.md index b934a5c2ca3..9f1d408fc79 100644 --- a/home/versioned_docs/version-v1.4.x/others/huaweicloud.md +++ b/home/versioned_docs/version-v1.4.x/others/huaweicloud.md @@ -1,26 +1,23 @@ --- id: huaweicloud title: HertzBeat & HuaweiCloud -sidebar_label: HertzBeat & HuaweiCloud +sidebar_label: HertzBeat & HuaweiCloud --- -### HertzBeat 与 HuaweiCloud 的开源合作需求Issue +### 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 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 开源活动 HuaweiCloud 华为云将面向开源软件工具链与环境、开源应用构建和开源生态组件构建这三大重点场景，提供技术支持、奖金支持、活动支持，邀请更多的开发者，携手构建开源for HuaweiCloud。 -开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 +开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 感兴趣的开发者可以查看：华为云开源项目仓库 https://gitee.com/HuaweiCloudDeveloper/huaweicloud-cloud-native-plugins-kits 了解更多。 diff --git a/home/versioned_docs/version-v1.4.x/others/images-deploy.md b/home/versioned_docs/version-v1.4.x/others/images-deploy.md index 782dbe83c05..ff350e763e0 100644 --- a/home/versioned_docs/version-v1.4.x/others/images-deploy.md +++ b/home/versioned_docs/version-v1.4.x/others/images-deploy.md @@ -1,10 +1,9 @@ --- id: images-deploy title: HertzBeat 华为云镜像部署 -sidebar_label: HertzBeat 华为云镜像部署快速指引 +sidebar_label: HertzBeat 华为云镜像部署快速指引 --- - > 易用友好的开源实时监控告警工具，无需Agent，强大自定义监控能力。 [![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr) @@ -20,20 +19,18 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 ![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) @@ -64,9 +61,9 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 - 和更多的自定义监控。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 -## 镜像部署 +## 镜像部署 -> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 +> HertzBeat支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 1. 开通服务器时选用 HertzBeat 镜像 2. 启动服务器 @@ -78,7 +75,6 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](../start/tdengine-init) - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](../start/iotdb-init) - 4. 配置用户配置文件(可选,自定义配置用户密码) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `/opt/hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 @@ -86,10 +82,10 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 5. 部署启动 执行位于安装目录/opt/hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - ``` + + ``` $ ./startup.sh ``` - 6. 开始探索HertzBeat 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 @@ -101,11 +97,14 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 1. **按照流程部署，访问 http://ip:1157/ 无界面** 请参考下面几点排查问题： + > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 > 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **监控历史图表长时间都一直无数据** + > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 + diff --git a/home/versioned_docs/version-v1.4.x/others/resource.md b/home/versioned_docs/version-v1.4.x/others/resource.md index a52a3173b10..4aeae0293b6 100644 --- a/home/versioned_docs/version-v1.4.x/others/resource.md +++ b/home/versioned_docs/version-v1.4.x/others/resource.md @@ -1,18 +1,18 @@ --- id: resource title: Related resources -sidebar_label: Related resources +sidebar_label: Related resources --- ## HertzBeat Introduce PDF -Download: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf) +Download: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf) -## Icon Resources +## Icon Resources -### HertzBeat Logo +### HertzBeat Logo -![logo](/img/hertzbeat-logo.svg) +![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) +Download: [SVG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.svg) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.jpg) diff --git a/home/versioned_docs/version-v1.4.x/others/sponsor.md b/home/versioned_docs/version-v1.4.x/others/sponsor.md index 6d6b57e15cd..ae338dbea3e 100644 --- a/home/versioned_docs/version-v1.4.x/others/sponsor.md +++ b/home/versioned_docs/version-v1.4.x/others/sponsor.md @@ -1,19 +1,13 @@ --- id: sponsor title: Sponsor -sidebar_label: 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** -**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) - +![wechat-alipay](/img/docs/pay.png) Thanks [JiShi Information(build a new microwave + optical transaction network)](https://www.flarespeed.com) sponsored server node. -Thanks [TianShang cloud computing(new wisdom cloud)](https://www.tsyvps.com/aff/BZBEGYLX) sponsored server node. - - - +Thanks [TianShang cloud computing(new wisdom cloud)](https://www.tsyvps.com/aff/BZBEGYLX) sponsored server node. diff --git a/home/versioned_docs/version-v1.4.x/start/account-modify.md b/home/versioned_docs/version-v1.4.x/start/account-modify.md index 0f6abc5b234..b1c618a8eda 100644 --- a/home/versioned_docs/version-v1.4.x/start/account-modify.md +++ b/home/versioned_docs/version-v1.4.x/start/account-modify.md @@ -1,7 +1,7 @@ --- id: account-modify title: Modify Account Username Password -sidebar_label: Update Account +sidebar_label: Update Account --- HertzBeat default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat @@ -114,7 +114,6 @@ account: > 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 @@ -126,4 +125,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**Restart HertzBeat, access http://ip:1157/ to explore** +**Restart HertzBeat, access http://ip:1157/ to explore** diff --git a/home/versioned_docs/version-v1.4.x/start/custom-config.md b/home/versioned_docs/version-v1.4.x/start/custom-config.md index 5a60d6b02b9..7554498bc6e 100644 --- a/home/versioned_docs/version-v1.4.x/start/custom-config.md +++ b/home/versioned_docs/version-v1.4.x/start/custom-config.md @@ -1,7 +1,7 @@ --- id: custom-config title: Advanced Params Config -sidebar_label: 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. @@ -12,13 +12,14 @@ This describes how to configure the SMS server, the number of built-in availabil 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` +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) +Add the following Tencent platform SMS server configuration in `application.yml` (parameters need to be replaced with your SMS server configuration) + ```yaml common: sms: @@ -32,7 +33,6 @@ common: 2. Configure alarm custom parameters - ```yaml alerter: # Custom console address @@ -44,6 +44,7 @@ alerter: > 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: @@ -56,3 +57,4 @@ warehouse: port: 6379 password: 123456 ``` + diff --git a/home/versioned_docs/version-v1.4.x/start/docker-deploy.md b/home/versioned_docs/version-v1.4.x/start/docker-deploy.md index 644079fde82..6b1cafd90d3 100644 --- a/home/versioned_docs/version-v1.4.x/start/docker-deploy.md +++ b/home/versioned_docs/version-v1.4.x/start/docker-deploy.md @@ -1,52 +1,51 @@ --- id: docker-deploy title: Install HertzBeat via Docker -sidebar_label: Install 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) + or in [quay.io mirror repository](https://quay.io/repository/apache/hertzbeat) + ```shell $ docker pull apache/hertzbeat $ docker pull apache/hertzbeat-collector ``` - or + + 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) - + 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 + For detail steps, please refer to [Configure Account Password](account-modify) +5. Start the HertzBeat Docker container -```shell +```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=en_US.UTF-8 \ -e TZ=Asia/Shanghai \ @@ -57,25 +56,25 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ --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.** +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 +6. Begin to explore HertzBeat - Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 7. Deploy collector cluster (Optional) -```shell +```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ @@ -84,53 +83,61 @@ $ docker run -d \ --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.** +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. +8. Access `http://localhost:1157` and you will see the registered new collector in dashboard. -**HAVE FUN** +**HAVE FUN** -### FAQ +### 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. + 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 .....` +> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy，visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issues： + 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** +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. +> 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** -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. +> 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) +> 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 -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. +> 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 index e4fcbe982ef..10dafda79b1 100644 --- a/home/versioned_docs/version-v1.4.x/start/greptime-init.md +++ b/home/versioned_docs/version-v1.4.x/start/greptime-init.md @@ -7,22 +7,25 @@ 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. +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.** +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** + +### Install GreptimeDB via Docker -### 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 +> 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 \ @@ -32,10 +35,11 @@ $ docker run -p 4000-4004:4000-4004 \ --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 +`-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) diff --git a/home/versioned_docs/version-v1.4.x/start/influxdb-init.md b/home/versioned_docs/version-v1.4.x/start/influxdb-init.md index 72cf7ca6129..0bea6129fb6 100644 --- a/home/versioned_docs/version-v1.4.x/start/influxdb-init.md +++ b/home/versioned_docs/version-v1.4.x/start/influxdb-init.md @@ -1,7 +1,7 @@ --- id: influxdb-init title: Use Time Series Database InfluxDB to Store Metrics Data (Optional) -sidebar_label: Use InfluxDB Store Metrics +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) @@ -11,41 +11,45 @@ TDengine is the Time Series Data Platform where developers build IoT, analytics, **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. +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. +> +> 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 +### 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. 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. + Replace `warehouse.store.influxdb` data source parameters, URL account and password. ```yaml warehouse: @@ -70,3 +74,4 @@ warehouse: 1. Do both the time series databases InfluxDB, IoTDB and TDengine need to be configured? Can they both be used? > You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. + diff --git a/home/versioned_docs/version-v1.4.x/start/iotdb-init.md b/home/versioned_docs/version-v1.4.x/start/iotdb-init.md index 57329621958..d015527ac1b 100644 --- a/home/versioned_docs/version-v1.4.x/start/iotdb-init.md +++ b/home/versioned_docs/version-v1.4.x/start/iotdb-init.md @@ -1,30 +1,32 @@ --- id: iotdb-init title: Use Time Series Database IoTDB to Store Metrics Data (Optional) -sidebar_label: Use IoTDB Store Metrics +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. +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. +**⚠️ 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 +> 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 \ @@ -33,14 +35,14 @@ $ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ 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 +`-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 +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. + Config the `warehouse.store.jpa.enabled` `false`. Replace `warehouse.store.iot-db` data source parameters, HOST account and password. ``` warehouse: @@ -62,18 +64,22 @@ warehouse: expire-time: '7776000000' ``` -4. Restart HertzBeat +4. Restart HertzBeat -### FAQ +### 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 +> You can check the startup logs according to the logs directory + diff --git a/home/versioned_docs/version-v1.4.x/start/mysql-change.md b/home/versioned_docs/version-v1.4.x/start/mysql-change.md index 16bbab1b067..5dc513d3650 100644 --- a/home/versioned_docs/version-v1.4.x/start/mysql-change.md +++ b/home/versioned_docs/version-v1.4.x/start/mysql-change.md @@ -1,41 +1,48 @@ --- id: mysql-change title: Use MYSQL Replace H2 Database to Store Metadata(Optional) -sidebar_label: Use MYSQL Instead of H2 +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. +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 -### 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. + 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 +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 +### Database creation + 1. Enter MYSQL or use the client to connect MYSQL service - `mysql -uroot -p123456` + `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 +### 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: @@ -44,7 +51,9 @@ spring: 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: + +Specific replacement parameters are as follows and you need to configure account according to the mysql environment: + ```yaml spring: datasource: @@ -54,4 +63,4 @@ spring: url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false ``` -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.4.x/start/package-deploy.md b/home/versioned_docs/version-v1.4.x/start/package-deploy.md index 21b7e2f5fe6..0111ef08114 100644 --- a/home/versioned_docs/version-v1.4.x/start/package-deploy.md +++ b/home/versioned_docs/version-v1.4.x/start/package-deploy.md @@ -3,20 +3,22 @@ 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 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 - ``` + 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) @@ -27,22 +29,23 @@ sidebar_label: Install via Package 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) + 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. - ``` + Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. + + ``` $ ./startup.sh ``` +5. Begin to explore HertzBeat -5. Begin to explore HertzBeat - - Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 6. Deploy collector clusters (Optional) - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [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: @@ -59,7 +62,7 @@ sidebar_label: Install via Package **HAVE FUN** -### FAQ +### FAQ 1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance** @@ -67,6 +70,7 @@ sidebar_label: Install via Package 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" @@ -74,18 +78,20 @@ sidebar_label: Install via Package Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) ``` - 2. **According to the process deploy，visit http://ip:1157/ no interface** 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. +> 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 index 5be6b466223..a6c1fdb580a 100644 --- a/home/versioned_docs/version-v1.4.x/start/postgresql-change.md +++ b/home/versioned_docs/version-v1.4.x/start/postgresql-change.md @@ -3,27 +3,35 @@ 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 + +1. Enter postgreSQL or use the client to connect postgreSQL service + ``` su - postgres psql @@ -39,6 +47,7 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition 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: @@ -47,7 +56,9 @@ spring: 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: @@ -70,4 +81,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.4.x/start/quickstart.md b/home/versioned_docs/version-v1.4.x/start/quickstart.md index 2b5b528d784..909594e1275 100644 --- a/home/versioned_docs/version-v1.4.x/start/quickstart.md +++ b/home/versioned_docs/version-v1.4.x/start/quickstart.md @@ -1,7 +1,7 @@ --- id: quickstart title: Quick Start -sidebar_label: Quick Start +sidebar_label: Quick Start --- ### 🐕 Quick Start @@ -29,6 +29,7 @@ sidebar_label: Quick Start ``` 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. @@ -45,6 +46,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do 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: @@ -68,9 +70,9 @@ Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.com/d 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) +Detailed steps refer to [CONTRIBUTING](../others/contributing) -##### 4：Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose +##### 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). @@ -82,4 +84,4 @@ 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** +**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 index 1ff4de9428f..d1fbf4763fa 100644 --- a/home/versioned_docs/version-v1.4.x/start/rainbond-deploy.md +++ b/home/versioned_docs/version-v1.4.x/start/rainbond-deploy.md @@ -1,7 +1,7 @@ --- id: rainbond-deploy title: Use Rainbond Deploy HertzBeat -sidebar_label: Install via Rainbond +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. diff --git a/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md b/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md index 41c9c2ed686..43253ed946b 100644 --- a/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md +++ b/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md @@ -33,7 +33,6 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate - ![](/img/docs/start/ssl_1.png) 2. Configure the monitoring website @@ -47,48 +46,38 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > 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 @@ -98,7 +87,6 @@ https://tancloud.cn/docs/help/alert_dingtalk > 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. diff --git a/home/versioned_docs/version-v1.4.x/start/tdengine-init.md b/home/versioned_docs/version-v1.4.x/start/tdengine-init.md index 928e9b25865..fc1615fa8c7 100644 --- a/home/versioned_docs/version-v1.4.x/start/tdengine-init.md +++ b/home/versioned_docs/version-v1.4.x/start/tdengine-init.md @@ -1,84 +1,89 @@ --- id: tdengine-init title: Use Time Series Database TDengine to Store Metrics Data (Optional) -sidebar_label: Use TDengine Store Metrics +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. +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. +Note⚠️ Need TDengine 3.x Version. -> If you have TDengine environment, can directly skip to create a database instance. +> If you have TDengine environment, can directly skip to create a database instance. +### Install TDengine via Docker -### 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. 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 -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: - + 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 - + + 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 - +3. Check if hertzbeat database has been created success + ``` taos> show databases; taos> use hertzbeat; ``` -**Note⚠️If you install TDengine using package** +**Note⚠️If you install TDengine using package** > In addition to start the server，you must execute `systemctl start taosadapter` to start adapter -### Configure the database connection in hertzbeat `application.yml` configuration file +### Configure the database connection in hertzbeat `application.yml` configuration file 1. Configure HertzBeat's configuration file Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.td-engine` data source parameters, URL account and password. + Replace `warehouse.store.td-engine` data source parameters, URL account and password. ```yaml warehouse: @@ -100,16 +105,21 @@ warehouse: ### 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. +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 +> 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 index d892370838e..101564dc00b 100644 --- a/home/versioned_docs/version-v1.4.x/start/upgrade.md +++ b/home/versioned_docs/version-v1.4.x/start/upgrade.md @@ -1,7 +1,7 @@ --- id: upgrade title: HertzBeat New Version Upgrade -sidebar_label: Version Upgrade Guide +sidebar_label: Version Upgrade Guide --- **HertzBeat Release Version List** @@ -15,7 +15,6 @@ HertzBeat's metadata information is stored in H2 or Mysql, PostgreSQL relational **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 @@ -23,30 +22,26 @@ HertzBeat's metadata information is stored in H2 or Mysql, PostgreSQL relational - `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 +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 +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 +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 +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** +**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 index c917d5cb7a4..66a91fd49af 100644 --- a/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md +++ b/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md @@ -1,13 +1,12 @@ --- id: victoria-metrics-init title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended) -sidebar_label: Use VictoriaMetrics Store Metrics +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** @@ -15,17 +14,19 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t > If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step. -### Install VictoriaMetrics via Docker +### 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 +> 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 \ @@ -34,8 +35,8 @@ $ docker run -d -p 8428:8428 \ 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 +`-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 @@ -61,5 +62,7 @@ warehouse: ### FAQ -1. Do both the time series databases need to be configured? Can they both be used? +1. Do both the time series databases need to be configured? Can they both be used? + > You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which can affects the historical chart data. + diff --git a/home/versioned_docs/version-v1.4.x/template.md b/home/versioned_docs/version-v1.4.x/template.md index a02c1d11925..6e82517f324 100644 --- a/home/versioned_docs/version-v1.4.x/template.md +++ b/home/versioned_docs/version-v1.4.x/template.md @@ -4,27 +4,27 @@ title: Monitoring Template Here sidebar_label: Monitoring Template --- -> Hertzbeat is an open source, real-time monitoring tool with custom-monitor and agentLess. - +> 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. +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!** +**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 +### 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)
+ 👉 [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)
@@ -32,7 +32,7 @@ Here is the architecture.  👉 [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 +### 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)
@@ -49,7 +49,7 @@ Here is the architecture.  👉 [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 +### 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)
@@ -64,7 +64,6 @@ Here is the architecture.  👉 [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)
@@ -78,13 +77,12 @@ Here is the architecture.  👉 [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 +### 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)
diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md index cb8cec5b7aa..9ccb0e9454b 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md @@ -4,14 +4,16 @@ 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. +> 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** +**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. +### HertzBeat data format specification + +Note⚠️ The response data is JSON format. Single layer format ：key-value + ```json { "metricName1": "metricValue", @@ -20,7 +22,9 @@ Single layer format ：key-value "metricName4": "metricValue" } ``` + Multilayer format：Set key value in the array + ```json [ { @@ -37,9 +41,11 @@ Multilayer format：Set key value in the array } ] ``` + eg： -Query the CPU information of the custom system. The exposed interface is `/metrics/cpu`. We need `hostname,core,useage` Metric. -If there is only one virtual machine, its single-layer format is : +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", @@ -49,7 +55,9 @@ If there is only one virtual machine, its single-layer format is : "runningTime": 100 } ``` -If there are multiple virtual machines, the multilayer format is: : + +If there are multiple virtual machines, the multilayer format is: : + ```json [ { @@ -76,7 +84,7 @@ If there are multiple virtual machines, the multilayer format is: : ] ``` -**The corresponding monitoring template yml can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -146,3 +154,4 @@ metrics: # Hertzbeat default parsing is used here parseType: default ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md index 4c65e29b8da..93a5c1e2dce 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md @@ -8,12 +8,10 @@ Through this tutorial, we describe step by step how to add a monitoring type bas 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, @@ -22,6 +20,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz } ``` + 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: @@ -63,16 +62,13 @@ As above, usually our background API interface will design such a general return **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 @@ -200,38 +196,30 @@ metrics: **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. +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md index b9bbb61e72d..7881b048357 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md @@ -22,6 +22,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz "identifier": "admin" } ``` + **The response structure data is as follows**: ```json @@ -40,11 +41,9 @@ Before reading this tutorial, we hope that you are familiar with how to customiz **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 @@ -214,15 +213,12 @@ metrics: ![](/img/docs/advanced/extend-http-example-5.png) - ** After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page. ** ![](/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** @@ -334,8 +330,7 @@ metrics: # 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 @@ -385,12 +380,12 @@ metrics: > 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. +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md index 772c96d20d3..86a49c06756 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md @@ -3,16 +3,18 @@ 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. +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** -**Use the JsonPath script to parse the response data into data that conforms to the data structure rules specified by HertzBeat** +#### JsonPath Operator -#### JsonPath Operator -[JSONPath online verification](https://www.jsonpath.cn) +[JSONPath online verification](https://www.jsonpath.cn) -| JSONPATH | Help description | +| JSONPATH | Help description | |------------------|----------------------------------------------------------------------------------------| | $ | Root object or element | | @ | Current object or element | @@ -25,8 +27,10 @@ Note⚠️ The response data is JSON format. | ?() | Filter (script) expression | | () | Script Expression | -#### HertzBeat data format specification +#### HertzBeat data format specification + Single layer format ：key-value + ```json { "metricName1": "metricValue", @@ -35,7 +39,9 @@ Single layer format ：key-value "metricName4": "metricValue" } ``` + Multilayer format：Set key value in the array + ```json [ { @@ -56,7 +62,8 @@ Multilayer format：Set key value in the array #### Example Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. -The raw data returned by the interface is as follows： +The raw data returned by the interface is as follows： + ```json { "firstName": "John", @@ -80,7 +87,8 @@ The raw data returned by the interface is as follows： } ``` -We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： +We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`，The parsed data structure is as follows： + ```json [ { @@ -93,9 +101,10 @@ We use the jsonpath script to parse, and the corresponding script is: `$.number[ } ] ``` + This data structure conforms to the data format specification of HertzBeat, and the Metric `type,num` is successfully extracted. -**The corresponding monitoring template yml can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -163,3 +172,4 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md index 242b63e8cf0..bab8800e7a1 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md @@ -1,35 +1,33 @@ --- id: extend-http title: HTTP Protocol Custom Monitoring -sidebar_label: 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 +> 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 +### 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. +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) - +**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 +### 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. +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. @@ -205,3 +203,4 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md index 3527ba60d5d..ec42f84f642 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md @@ -1,68 +1,73 @@ --- id: extend-jdbc title: JDBC Protocol Custom Monitoring -sidebar_label: 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**】 +> 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 +### 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. +#### **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. +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. + +> 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. +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. + +> 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： +SQL response data： -| key | value | -|---------|-------| -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +| 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 +### 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. - +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 @@ -236,3 +241,4 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md index 5284118f8a7..2f9ba992f63 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md @@ -1,12 +1,14 @@ --- id: extend-jmx title: JMX Protocol Custom Monitoring -sidebar_label: 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. @@ -15,25 +17,24 @@ It can be seen from the process that we define a monitoring type of JMX protocol 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 +### 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 @@ -191,3 +192,4 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md index c07c5ae8ca0..2047e1d1cf5 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md @@ -22,9 +22,9 @@ Mapping the fields returned by NGQL queries to the metrics we need allows us to For example: - online_meta_count#SHOW HOSTS META#Status#ONLINE - Counts the number of rows returned by `SHOW HOSTS META` where Status equals ONLINE. +Counts the number of rows returned by `SHOW HOSTS META` where Status equals ONLINE. - online_meta_count#SHOW HOSTS META## - Counts the number of rows returned by `SHOW HOSTS META`. +Counts the number of rows returned by `SHOW HOSTS META`. #### **oneRow** @@ -68,12 +68,13 @@ Notes: ![HertzBeat Page](/img/docs/advanced/extend-point-1.png) ------- + Configuration usages of the monitoring templates yml are detailed below. ### Monitoring Template YML > We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -> Monitoring template is used to define the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information, etc. +> Monitoring template is used to define the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information, etc. eg: Customize a monitoring type named example_ngql, which collects metric data using NGQL. @@ -165,3 +166,4 @@ metrics: - match (v:tag2) return "tag2" as name ,count(v) as cnt timeout: ^_^timeout^_^ ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-point.md b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md index eba1811e4fc..314e3f1affa 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-point.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md @@ -1,31 +1,29 @@ --- id: extend-point title: Custom Monitoring -sidebar_label: 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 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. -**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** +### 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 +### 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 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** - +**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 @@ -132,3 +130,4 @@ metrics: parseType: website ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md index c97aea1f766..b3bb9173c87 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md @@ -1,23 +1,22 @@ --- id: extend-snmp title: SNMP Protocol Custom Monitoring -sidebar_label: 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** @@ -25,18 +24,17 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p ![](/img/docs/advanced/extend-point-1.png) ------- + Configuration usages of the monitoring templates yml are detailed below. ### 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 @@ -171,3 +169,4 @@ metrics: processes: 1.3.6.1.2.1.25.1.6.0 location: 1.3.6.1.2.1.1.6.0 ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md index 772ee315207..bf960376179 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md @@ -1,21 +1,25 @@ --- id: extend-ssh title: SSH Protocol Custom Monitoring -sidebar_label: 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**】 +> 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 +### 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. +#### **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 @@ -23,31 +27,37 @@ 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： +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` +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 +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. + +> 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： +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： +Console response is： + ```shell total used free buff_cache available 7962 4066 331 3564 3592 @@ -60,18 +70,17 @@ Here the Metric field and the response data can be mapped into collected data on **HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** ------- + Configuration usages of the monitoring templates yml are detailed below. ### 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 @@ -203,3 +212,4 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` + diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md index 9f21219a29f..f991b5702e8 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md @@ -8,12 +8,10 @@ Through this tutorial, we describe step by step how to customize and adapt a mon 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, @@ -22,6 +20,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz } ``` + 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: @@ -58,17 +57,14 @@ As above, usually our background API interface will design such a general return **This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** - ### 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** @@ -199,32 +195,24 @@ metrics: **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! diff --git a/home/versioned_docs/version-v1.5.x/community/become_committer.md b/home/versioned_docs/version-v1.5.x/community/become_committer.md index f2824bdc4ed..382e69fb9bf 100644 --- a/home/versioned_docs/version-v1.5.x/community/become_committer.md +++ b/home/versioned_docs/version-v1.5.x/community/become_committer.md @@ -5,20 +5,20 @@ sidebar_position: 2 --- ## Become A Committer of Apache HertzBeat @@ -66,6 +66,7 @@ of the main website or HertzBeat's GitHub repositories. - +1 month with solid activity and engagement. ### Quality of contributions + - A solid general understanding of the project - Well tested, well-designed, following Apache HertzBeat coding standards, and simple patches. @@ -82,3 +83,4 @@ of the main website or HertzBeat's GitHub repositories. - Be involved in the design road map discussions with a professional and diplomatic approach even if there is a disagreement - Promoting the project by writing articles or holding events + diff --git a/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md b/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md index cf48cbe7c82..cd9dff4e02a 100644 --- a/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md +++ b/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md @@ -5,20 +5,20 @@ sidebar_position: 3 --- ## Become A PMC member of Apache HertzBeat @@ -66,6 +66,7 @@ of the main website or HertzBeat's GitHub repositories. - +3 month with solid activity and engagement. ### Quality of contributions + - A solid general understanding of the project - Well tested, well-designed, following Apache HertzBeat coding standards, and simple patches. @@ -82,3 +83,4 @@ of the main website or HertzBeat's GitHub repositories. - Be involved in the design road map discussions with a professional and diplomatic approach even if there is a disagreement - Promoting the project by writing articles or holding events + diff --git a/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md index 755a98f3fd7..c86438a577e 100644 --- a/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md +++ b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md @@ -5,39 +5,36 @@ sidebar_position: 3 --- - ## 1 Pull Requests & Changes Rule 1. `ISSUE`/`PR`(pull request) driving and naming - - After creating a new `PR`, you need to associate the existing corresponding `ISSUE` at the Github Development button on the `PR` page (if there is no corresponding ISSUE, it is recommended to create a new corresponding ISSUE). + - After creating a new `PR`, you need to associate the existing corresponding `ISSUE` at the Github Development button on the `PR` page (if there is no corresponding ISSUE, it is recommended to create a new corresponding ISSUE). - - Title naming format - `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + - Title naming format + `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` 2. Description - - Please fill in the `PR` template to describe the contribution. So that the reviewer can understand the problem and solution from the description, rather than just from the code. - - Check the CheckList - + - Please fill in the `PR` template to describe the contribution. So that the reviewer can understand the problem and solution from the description, rather than just from the code. + - Check the CheckList 3. It's recommended that `PR` should be arranged changes such as `cleanup`, `Refactor`, `improve`, and `feature` into separated `PRs`/`Commits`. - 4. Commit message(English, lowercase, no special characters) The commit of messages should follow a pattern similar to the `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` @@ -50,11 +47,11 @@ sidebar_position: 3 3. Set **Checkstyle version** to **10.14.2**. 4. Set **Scan scope** to **Only Java sources (including tests)**. 5. Click **+** button in the **Configuration** section to open a dialog to choose the checkstyle config file. - 1. Enter a **Description**. For example, hertzbeat. - 2. Select **Use a local checkstyle file**. - 3. Set **File** to **script/checkstyle/checkstyle.xml**. - 4. Select **Store relative to project location**. - 5. Click **Next** → **Next** → **Finish**. + 1. Enter a **Description**. For example, hertzbeat. + 2. Select **Use a local checkstyle file**. + 3. Set **File** to **script/checkstyle/checkstyle.xml**. + 4. Select **Store relative to project location**. + 5. Click **Next** → **Next** → **Finish**. 6. Activate the configuration you just added by toggling the corresponding box. 7. Click **OK**. @@ -69,96 +66,94 @@ sidebar_position: 3 ### 3.1 Naming Style 1. Prioritize selecting nouns for variable naming, it's easier to distinguish between `variables` or `methods`. + ```java - Cache publicKeyCache; + Cache publicKeyCache; ``` - 2. Pinyin abbreviations are prohibited for variables (excluding nouns such as place names), such as chengdu. - 3. It is recommended to end variable names with a `type`. For variables of type `Collection/List`, take `xxxx` (plural representing multiple elements) or end with `xxxList` (specific type). For variables of type `map`, describe the `key` and `value` clearly: + ```java - Map idUserMap; - Map userIdNameMap; + Map idUserMap; + Map userIdNameMap; ``` - 4. That can intuitively know the type and meaning of the variable through its name. Method names should start with a verb first as follows: + ```java - void computeVcores(Object parameter1); + void computeVcores(Object parameter1); ``` + > Note: It is not necessary to strictly follow this rule in the `Builder` tool class. - ### 3.2 Constant Variables Definition -1. Redundant strings should be extracted as constants - >If a constant has been hardcoded twice or more times, please directly extract it as a constant and change the corresponding reference. - In generally, constants in `log` can be ignored to extract. - - - Negative demo: - - ```java - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put("status", "success"); - resp.put("code", ResponseCode.CODE_SUCCESS); - resp.put("data", data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put("status", "error"); - resp.put("code", ResponseCode.CODE_FAIL); - resp.put("data", null); - return resp; - } - ``` - - - Positive demo: - - > Strings are extracted as constant references. - - ```java - public static final String STATUS = "status"; - public static final String CODE = "code"; - public static final String DATA = "data"; - - public static RestResponse success(Object data) { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "success"); - resp.put(CODE, ResponseCode.CODE_SUCCESS); - resp.put(DATA, data); - return resp; - } - - public static RestResponse error() { - RestResponse resp = new RestResponse(); - resp.put(STATUS, "error"); - resp.put(CODE, ResponseCode.CODE_FAIL); - resp.put(DATA, null); - return resp; - } - ``` +1. Redundant strings should be extracted as constants + + > If a constant has been hardcoded twice or more times, please directly extract it as a constant and change the corresponding reference. + > In generally, constants in `log` can be ignored to extract. + + - Negative demo: + + ```java + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put("status", "success"); + resp.put("code", ResponseCode.CODE_SUCCESS); + resp.put("data", data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put("status", "error"); + resp.put("code", ResponseCode.CODE_FAIL); + resp.put("data", null); + return resp; + } + ``` + - Positive demo: + + > Strings are extracted as constant references. + + ```java + public static final String STATUS = "status"; + public static final String CODE = "code"; + public static final String DATA = "data"; + + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "success"); + resp.put(CODE, ResponseCode.CODE_SUCCESS); + resp.put(DATA, data); + return resp; + } + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "error"); + resp.put(CODE, ResponseCode.CODE_FAIL); + resp.put(DATA, null); + return resp; + } + ``` 2. Ensure code readability and intuitiveness - - The string in the `annotation` symbol doesn't need to be extracted as constant. +- The string in the `annotation` symbol doesn't need to be extracted as constant. - - The referenced `package` or `resource` name doesn't need to be extracted as constant. +- The referenced `package` or `resource` name doesn't need to be extracted as constant. 3. Variables that have not been reassigned must also be declared as final types. -4. About the arrangement order of `constant/variable` lines +4. About the arrangement order of `constant/variable` lines Sort the variable lines in the class in the order of 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` 2. `public static v`, `static v`,`protected static v`, `private static v` 3. `public v`, `v`, `protected v`, `private v` - ### 3.3 Methods Rule 1. Sort the methods in the class in the order of `public`, `protected`, `private` @@ -174,9 +169,9 @@ sidebar_position: 3 3. If there are too many lines of code in the method, please have a try on using multiple sub methods at appropriate points to segment the method body. Generally speaking, it needs to adhere to the following principles: - - Convenient testing - - Good semantics - - Easy to read + - Convenient testing + - Good semantics + - Easy to read In addition, it is also necessary to consider whether the splitting is reasonable in terms of components, logic, abstraction, and other aspects in the scenario. @@ -185,35 +180,31 @@ sidebar_position: 3 ### 3.4 Collection Rule 1. For `collection` returned values, unless there are special `concurrent` (such as thread safety), always return the `interface`, such as: - - - returns List if use `ArrayList` - - returns Map if use `HashMap` - - returns Set if use `HashSet` - + - returns List if use `ArrayList` + - returns Map if use `HashMap` + - returns Set if use `HashSet` 2. If there are multiple threads, the following declaration or returned types can be used: - ```java - private CurrentHashMap map; - public CurrentHashMap funName(); - ``` +```java +private CurrentHashMap map; +public CurrentHashMap funName(); +``` 3. Use `isEmpty()` instead of `length() == 0` or `size() == 0` + - Negative demo： - - Negative demo： - - ```java - if (pathPart.length() == 0) { - return; - } - ``` - - - Positive demo： + ```java + if (pathPart.length() == 0) { + return; + } + ``` + - Positive demo： - ```java - if (pathPart.isEmpty()) { - return; - } - ``` + ```java + if (pathPart.isEmpty()) { + return; + } + ``` ### 3.5 Concurrent Processing @@ -226,9 +217,8 @@ sidebar_position: 3 ### 3.6 Control/Condition Statements 1. Avoid unreasonable `condition/control` branches order leads to: - - - Multiple code line `depths` of `n+1` - - Redundant lines + - Multiple code line `depths` of `n+1` + - Redundant lines Generally speaking, if a method's code line depth exceeds `2+ Tabs` due to continuous nested `if... else..`, it should be considered to try - `merging branches`, @@ -237,77 +227,85 @@ Generally speaking, if a method's code line depth exceeds `2+ Tabs` due to conti to reduce code line depth and improve readability like follows: - Union or merge the logic into the next level calling - - Negative demo: - ```java - if (isInsert) { - save(platform); - } else { - updateById(platform); - } - ``` - - Positive demo: - ```java - saveOrUpdate(platform); - ``` +- Negative demo: + +```java +if (isInsert) { +save(platform); +} else { +updateById(platform); +} +``` + +- Positive demo: + +```java +saveOrUpdate(platform); +``` + - Merge the conditions - - Negative demo: - ```java - if (expression1) { - if(expression2) { - ...... - } - } - ``` - - Positive demo: - ```java - if (expression1 && expression2) { - ...... - } - ``` +- Negative demo: + +```java +if (expression1) { +if(expression2) { +...... +} +} + +``` + +- Positive demo: + + ```java + if (expression1 && expression2) { + ...... + } + ``` - Reverse the condition - - Negative demo: - - ```java - public void doSomething() { - // Ignored more deeper block lines - // ..... - if (condition1) { - ... - } else { - ... - } - } - ``` - - - Positive demo: - - ```java - public void doSomething() { - // Ignored more deeper block lines - // ..... - if (!condition1) { - ... - return; - } - // ... - } - ``` +- Negative demo: + + ```java + public void doSomething() { + // Ignored more deeper block lines + // ..... + if (condition1) { + ... + } else { + ... + } + } + ``` +- Positive demo: + + ```java + public void doSomething() { + // Ignored more deeper block lines + // ..... + if (!condition1) { + ... + return; + } + // ... + } + ``` - Using a single variable or method to reduce the complex conditional expression - - Negative demo: - ```java - if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { - ... - } - ``` - - - Positive demo: - ```java - if (containsSqlServer(dbType)) { - .... - } - //..... - // definition of the containsSqlServer - ``` +- Negative demo: + + ```java + if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { + ... + } + ``` +- Positive demo: + + ```java + if (containsSqlServer(dbType)) { + .... + } + //..... + // definition of the containsSqlServer + ``` > Using `sonarlint` and `better highlights` to check code depth looks like good in the future. @@ -315,22 +313,22 @@ to reduce code line depth and improve readability like follows: 1. Method lacks comments: - - `When`: When can the method be called - - `How`: How to use this method and how to pass parameters, etc. - - `What`: What functions does this method achieve - - `Note`: What should developers pay attention to when calling this method +- `When`: When can the method be called +- `How`: How to use this method and how to pass parameters, etc. +- `What`: What functions does this method achieve +- `Note`: What should developers pay attention to when calling this method 2. Missing necessary class header description comments. - Add `What`, `Note`, etc. like mentioned in the `1`. +Add `What`, `Note`, etc. like mentioned in the `1`. 3. The method declaration in the interface must be annotated. - - If the semantics of the implementation and the annotation content at the interface declaration are inconsistent, the specific implementation method also needs to be rewritten with annotations. +- If the semantics of the implementation and the annotation content at the interface declaration are inconsistent, the specific implementation method also needs to be rewritten with annotations. - - If the semantics of the method implementation are consistent with the annotation content at the interface declaration, it is not recommended to write annotations to avoid duplicate annotations. +- If the semantics of the method implementation are consistent with the annotation content at the interface declaration, it is not recommended to write annotations to avoid duplicate annotations. -4. The first word in the comment lines need to be capitalized, like `param` lines, `return` lines. +4. The first word in the comment lines need to be capitalized, like `param` lines, `return` lines. If a special reference as a subject does not need to be capitalized, special symbols such as quotation marks need to be noted. ### 3.8 Java Lambdas @@ -338,31 +336,29 @@ to reduce code line depth and improve readability like follows: 1. Prefer `non-capturing` lambdas (lambdas that do not contain references to the outer scope). Capturing lambdas need to create a new object instance for every call. `Non-capturing` lambdas can use the same instance for each invocation. - - Negative demo: +- Negative demo: - ```java - map.computeIfAbsent(key, x -> key.toLowerCase()) - ``` - - - Positive demo: + ```java + map.computeIfAbsent(key, x -> key.toLowerCase()) + ``` +- Positive demo: - ```java - map.computeIfAbsent(key, k -> k.toLowerCase()); - ``` + ```java + map.computeIfAbsent(key, k -> k.toLowerCase()); + ``` 2. Consider method references instead of inline lambdas - - Negative demo: - - ```java - map.computeIfAbsent(key, k-> Loader.load(k)); - ``` +- Negative demo: - - Positive demo: + ```java + map.computeIfAbsent(key, k-> Loader.load(k)); + ``` +- Positive demo: - ```java - map.computeIfAbsent(key, Loader::load); - ``` + ```java + map.computeIfAbsent(key, Loader::load); + ``` ### 3.9 Java Streams @@ -380,186 +376,180 @@ to reduce code line depth and improve readability like follows: 1. Use `StringUtils.isBlank` instead of `StringUtils.isEmpty` - - Negative demo: - - ```java - if (StringUtils.isEmpty(name)) { - return; - } - ``` - - - Positive demo: - - ```java - if (StringUtils.isBlank(name)) { - return; - } - ``` +- Negative demo: + + ```java + if (StringUtils.isEmpty(name)) { + return; + } + ``` +- Positive demo: + + ```java + if (StringUtils.isBlank(name)) { + return; + } + ``` 2. Use `StringUtils.isNotBlank` instead of `StringUtils.isNotEmpty` - - Negative demo: - - ```java - if (StringUtils.isNotEmpty(name)) { - return; - } - ``` - - - Positive demo: - - ```java - if (StringUtils.isNotBlank(name)) { - return; - } - ``` +- Negative demo: + + ```java + if (StringUtils.isNotEmpty(name)) { + return; + } + ``` +- Positive demo: + + ```java + if (StringUtils.isNotBlank(name)) { + return; + } + ``` 3. Use `StringUtils.isAllBlank` instead of `StringUtils.isAllEmpty` - - Negative demo: - - ```java - if (StringUtils.isAllEmpty(name, age)) { - return; - } - ``` - - - Positive demo: - - ```java - if (StringUtils.isAllBlank(name, age)) { - return; - } - ``` +- Negative demo: + + ```java + if (StringUtils.isAllEmpty(name, age)) { + return; + } + ``` +- Positive demo: + + ```java + if (StringUtils.isAllBlank(name, age)) { + return; + } + ``` ### 3.12 `Enum` Class 1. Enumeration value comparison - - Negative demo: - - ```java - if (status.equals(JobStatus.RUNNING)) { - return; - } - ``` - - - Positive demo: - - ```java - if (status == JobStatus.RUNNING) { - return; - } - ``` +- Negative demo: + + ```java + if (status.equals(JobStatus.RUNNING)) { + return; + } + ``` +- Positive demo: + + ```java + if (status == JobStatus.RUNNING) { + return; + } + ``` 2. Enumeration classes do not need to implement Serializable - - Negative demo: - - ```java - public enum JobStatus implements Serializable { - ... - } - ``` - - - Positive demo: - - ```java - public enum JobStatus { - ... - } - ``` +- Negative demo: + + ```java + public enum JobStatus implements Serializable { + ... + } + ``` +- Positive demo: + + ```java + public enum JobStatus { + ... + } + ``` 3. Use `Enum.name()` instead of `Enum.toString()` - - Negative demo: - - ```java - System.out.println(JobStatus.RUNNING.toString()); - ``` - - - Positive demo: - - ```java - System.out.println(JobStatus.RUNNING.name()); - ``` +- Negative demo: + + ```java + System.out.println(JobStatus.RUNNING.toString()); + ``` +- Positive demo: + + ```java + System.out.println(JobStatus.RUNNING.name()); + ``` 4. Enumeration class names uniformly use the Enum suffix - - Negative demo: - - ```java - public enum JobStatus { - ... - } - ``` - - - Positive demo: - - ```java - public enum JobStatusEnum { - ... - } - ``` +- Negative demo: + + ```java + public enum JobStatus { + ... + } + ``` +- Positive demo: + + ```java + public enum JobStatusEnum { + ... + } + ``` ### 3.13 `Deprecated` Annotation - - Negative demo: +- Negative demo: - ```java - @deprecated - public void process(String input) { - ... - } - ``` +```java +@deprecated +public void process(String input) { + ... +} +``` - - Positive demo: +- Positive demo: - ```java - @Deprecated - public void process(String input) { - ... - } - ``` +```java +@Deprecated +public void process(String input) { + ... +} +``` ## 4 Log 1. Use `placeholders` for log output: - - Negative demo - ```java - log.info("Deploy cluster request " + deployRequest); - ``` - - Positive demo - ```java - log.info("load plugin:{} to {}", file.getName(), appPlugins); - ``` +- Negative demo -2. Pay attention to the selection of `log level` when printing logs + ```java + log.info("Deploy cluster request " + deployRequest); + ``` +- Positive demo + + ```java + log.info("load plugin:{} to {}", file.getName(), appPlugins); + ``` - When printing the log content, if the actual parameters of the log placeholder are passed, it is necessary to avoid premature evaluation to avoid unnecessary evaluation caused by the log level. +2. Pay attention to the selection of `log level` when printing logs - - Negative demo: +When printing the log content, if the actual parameters of the log placeholder are passed, it is necessary to avoid premature evaluation to avoid unnecessary evaluation caused by the log level. - Assuming the current log level is `INFO`: +- Negative demo: - ```java - // ignored declaration lines. - List userList = getUsersByBatch(1000); - LOG.debug("All users: {}", getAllUserIds(userList)); - ``` + Assuming the current log level is `INFO`: - - Positive demo: + ```java + // ignored declaration lines. + List userList = getUsersByBatch(1000); + LOG.debug("All users: {}", getAllUserIds(userList)); + ``` +- Positive demo: - In this case, we should determine the log level in advance before making actual log calls as follows: + In this case, we should determine the log level in advance before making actual log calls as follows: - ```java - // ignored declaration lines. - List userList = getUsersByBatch(1000); - if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); - } - ``` + ```java + // ignored declaration lines. + List userList = getUsersByBatch(1000); + if (LOG.isDebugEnabled()) { + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + } + ``` ## 5 Testing @@ -568,8 +558,14 @@ to reduce code line depth and improve readability like follows: 2. The implemented interface needs to write the `e2e` test case script under the `e2e` module. ## References + - https://site.mockito.org/ - https://alibaba.github.io/p3c/ - https://rules.sonarsource.com/java/ - https://junit.org/junit5/ - https://streampark.apache.org/ + +``` + +``` + diff --git a/home/versioned_docs/version-v1.5.x/community/contact.md b/home/versioned_docs/version-v1.5.x/community/contact.md index 91a4659ae5c..decd6d27c8c 100644 --- a/home/versioned_docs/version-v1.5.x/community/contact.md +++ b/home/versioned_docs/version-v1.5.x/community/contact.md @@ -1,7 +1,7 @@ --- id: contact title: Join discussion -sidebar_label: 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. diff --git a/home/versioned_docs/version-v1.5.x/community/contribution.md b/home/versioned_docs/version-v1.5.x/community/contribution.md index 06987053696..f7d932bcd2c 100644 --- a/home/versioned_docs/version-v1.5.x/community/contribution.md +++ b/home/versioned_docs/version-v1.5.x/community/contribution.md @@ -5,20 +5,20 @@ sidebar_position: 0 --- > We are committed to maintaining a happy community that helps each other, welcome every contributor to join us! @@ -50,7 +50,6 @@ Even small corrections to typos are very welcome :) > To get HertzBeat code running on your development tools, and able to debug with breakpoints. > This is a front-end and back-end separation project. To start the local code, the back-end manager and the front-end web-app must be started separately. - #### Backend start 1. Requires `maven3+`, `java17` and `lombok` environments @@ -88,23 +87,31 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D 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. @@ -137,6 +144,7 @@ git pull upstream master ``` ### HertzBeat Improvement Proposal (HIP) + If you have major new features(e.g., support metrics push gateway, support logs monitoring), you need to write a design document known as a HertzBeat Improvement Proposal (HIP). Before starting to write a HIP, make sure you follow the process [here](https://github.com/apache/hertzbeat/tree/master/hip). ### How to become a Committer? @@ -152,14 +160,15 @@ Add WeChat account `ahertzbeat` to pull you into the WeChat group. ## 🥐 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. +> - **[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. +> - **[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. +> - **[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. +> - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** Provide web ui. > Angular Web UI. ![hertzBeat](/img/docs/hertzbeat-arch.png) diff --git a/home/versioned_docs/version-v1.5.x/community/development.md b/home/versioned_docs/version-v1.5.x/community/development.md index 6bc9544a900..549084ce516 100644 --- a/home/versioned_docs/version-v1.5.x/community/development.md +++ b/home/versioned_docs/version-v1.5.x/community/development.md @@ -1,7 +1,7 @@ --- id: development title: How to Run or Build HertzBeat? -sidebar_label: Development +sidebar_label: Development --- ## Getting HertzBeat code up and running @@ -10,7 +10,6 @@ sidebar_label: Development > This is a front-end and back-end separation project. > To start the local code, the back-end [manager](https://github.com/apache/hertzbeat/tree/master/manager) and the front-end [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) must be started separately. - ### Backend start 1. Requires `maven3+`, `java17` and `lombok` environments @@ -37,9 +36,9 @@ sidebar_label: Development 7. Browser access to localhost:4200 to start, default account/password is *admin/hertzbeat* -## Build HertzBeat binary package +## Build HertzBeat binary package -> Requires `maven3+`, `java17`, `node` and `yarn` environments. +> Requires `maven3+`, `java17`, `node` and `yarn` environments. ### Frontend build @@ -53,7 +52,6 @@ sidebar_label: Development 5. Build web-app: `yarn package` - ### Backend build 1. Requires `maven3+`, `java17` environments diff --git a/home/versioned_docs/version-v1.5.x/community/document.md b/home/versioned_docs/version-v1.5.x/community/document.md index a4f871bb753..e561b3f1b2c 100644 --- a/home/versioned_docs/version-v1.5.x/community/document.md +++ b/home/versioned_docs/version-v1.5.x/community/document.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- Good documentation is critical for any type of software. Any contribution that can improve the HertzBeat documentation is welcome. @@ -94,4 +94,3 @@ css and other style files are placed in the `src/css` directory > All pages doc can be directly jumped to the corresponding github resource modification page through the 'Edit this page' button at the bottom - diff --git a/home/versioned_docs/version-v1.5.x/community/how-to-release.md b/home/versioned_docs/version-v1.5.x/community/how-to-release.md index 8ffca0302cb..ed4bdfb636a 100644 --- a/home/versioned_docs/version-v1.5.x/community/how-to-release.md +++ b/home/versioned_docs/version-v1.5.x/community/how-to-release.md @@ -22,11 +22,11 @@ This release process is operated in the UbuntuOS(Windows,Mac), and the following ## 2. Preparing for release > First summarize the account information to better understand the operation process, will be used many times later. -- apache id: `muchunjin (APACHE LDAP UserName)` -- apache passphrase: `APACHE LDAP Passphrase` -- apache email: `muchunjin@apache.org` -- gpg real name: `muchunjin (Any name can be used, here I set it to the same name as the apache id)` -- gpg key passphrase: `The password set when creating the gpg key, you need to remember this password` +> - apache id: `muchunjin (APACHE LDAP UserName)` +> - apache passphrase: `APACHE LDAP Passphrase` +> - apache email: `muchunjin@apache.org` +> - gpg real name: `muchunjin (Any name can be used, here I set it to the same name as the apache id)` +> - gpg key passphrase: `The password set when creating the gpg key, you need to remember this password` ### 2.1 Key generation @@ -165,11 +165,10 @@ $ (gpg --list-sigs muchunjin@apache.org && gpg --export --armor muchunjin@apache $ svn ci -m "add gpg key for muchunjin" ``` -## 3. Prepare material package & release +## 3. Prepare material package & release #### 3.1 Based on the master branch, create a release-${release_version}-rcx branch, such as release-1.6.0-rc1, And create a tag named v1.6.0-rc1 based on the release-1.6.0-rc1 branch, and set this tag as pre-release. - ```shell git checkout master git checkout -b release-1.6.0-rc1 @@ -292,7 +291,7 @@ apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz: OK #### 3.7 Publish the dev directory of the Apache SVN material package -- Clone the dev directory +- Clone the dev directory ```shell # Check out the dev directory of the Apache SVN to the svn/dev directory under dist in the root directory of the Apache HertzBeat project @@ -331,7 +330,6 @@ svn commit -m "release for HertzBeat 1.6.0" > Visit the address https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ in the browser, check if existed the new material package - ## 4. Enter the community voting stage #### 4.1 Send a Community Vote Email @@ -340,7 +338,7 @@ Send a voting email in the community requires at least three `+1` and no `-1`. > `Send to`: dev@hertzbeat.apache.org
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
-> `Body`: +> `Body`: ``` Hello HertzBeat Community: @@ -403,8 +401,7 @@ Dear HertzBeat community, Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" I'm happy to announce the vote has passed: - - +--- 4 binding +1, from: - cc @@ -412,17 +409,14 @@ I'm happy to announce the vote has passed: 1 non-binding +1, from: - Roc Marshal - - +--- no 0 or -1 votes. Vote thread: https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq - - +--- Thank you to everyone who helped us to verify and vote for this release. We will move to the ASF Incubator voting shortly. - - +--- Best, ChunJin Mu ``` @@ -474,17 +468,14 @@ More detailed checklist please refer: Steps to validate the release， Please refer to: • https://www.apache.org/info/verification.html • https://hertzbeat.apache.org/docs/community/how_to_verify_release - - +--- How to Build: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package - - +--- Thanks, On behalf of Apache HertzBeat (incubating) community - - +--- Best, ChunJin Mu ``` @@ -546,10 +537,9 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http https://github.com/apache/hertzbeat/blob/master/home/docs/download.md https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md - Open the official website address https://hertzbeat.apache.org/docs/download/ to see if there is a new version of the download -> It should be noted that the download link may take effect after an hour, so please pay attention to it. +> It should be noted that the download link may take effect after an hour, so please pay attention to it. #### 4.3 Generate a release on github @@ -560,11 +550,14 @@ You can modify it on the original RC Release without creating a new Release. ::: Then enter Release Title and Describe -- Release Title: +- Release Title: + ``` v1.6.0 ``` + - Describe: + ``` xxx release note: xxx @@ -596,8 +589,7 @@ Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 HertzBeat Resources: - Issue: https://github.com/apache/hertzbeat/issues - Mailing list: dev@hertzbeat.apache.org - - +--- Apache HertzBeat Team Best, @@ -608,4 +600,4 @@ This version release is over. --- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/versioned_docs/version-v1.5.x/community/how-to-verify.md b/home/versioned_docs/version-v1.5.x/community/how-to-verify.md index 41c3341b59e..38b507149b0 100644 --- a/home/versioned_docs/version-v1.5.x/community/how-to-verify.md +++ b/home/versioned_docs/version-v1.5.x/community/how-to-verify.md @@ -40,7 +40,6 @@ The package uploaded to dist must include the source code package, and the binar 3. Whether to include the sha512 of the source code package 4. If the binary package is uploaded, also check the contents listed in (2)-(4) - ### 2.2 Check gpg signature First import the publisher's public key. Import KEYS from the svn repository to the local environment. (The person who releases the version does not need to import it again, the person who helps to do the verification needs to import it, and the user name is enough for the person who issued the version) @@ -51,6 +50,7 @@ First import the publisher's public key. Import KEYS from the svn repository to $ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # Download KEYS $ gpg --import KEYS # Import KEYS to local ``` + #### 2.2.2 Trust the public key Trust the KEY used in this version: @@ -123,8 +123,6 @@ check as follows: - [ ] Able to compile correctly - [ ] ..... - - ### 2.5 Check the source package > If the binary/web-binary package is uploaded, check the binary package. @@ -151,7 +149,6 @@ and check as follows: You can refer to this article: [ASF Third Party License Policy](https://apache.org/legal/resolved.html) - ## 3. Email reply If you initiate a posting vote, you can refer to this response example to reply to the email after verification @@ -170,9 +167,9 @@ If you have already voted on dev@hertzbeat.apache.org, you can take it directly //Incubator community voting, only IPMC members have binding binding，PPMC needs to be aware of binding changes Forward my +1 from dev@listhertzbeatnkis (non-binding) Copy my +1 from hertzbeat DEV ML (non-binding) -```` -::: +``` +::: Non-PPMC/Non-IPMC member: @@ -184,7 +181,7 @@ I checked: 3. LICENSE and NOTICE are exist 4. Build successfully on macOS(Big Sur) 5. -```` +``` PPMC/IPMC member: @@ -197,10 +194,8 @@ I checked: 3. LICENSE and NOTICE are exist 4. Build successfully on macOS(Big Sur) 5. -```` - - +``` --- -This doc refer from [Apache StreamPark](https://streampark.apache.org/) +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/versioned_docs/version-v1.5.x/community/mailing_lists.md b/home/versioned_docs/version-v1.5.x/community/mailing_lists.md index fed6e3928ee..c5ab8df7604 100644 --- a/home/versioned_docs/version-v1.5.x/community/mailing_lists.md +++ b/home/versioned_docs/version-v1.5.x/community/mailing_lists.md @@ -5,20 +5,20 @@ sidebar_position: 1 --- The [Developer Mailing List](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) is the community-recommended way to communicate and obtain the latest information. @@ -32,18 +32,17 @@ Before you post anything to the mailing lists, be sure that you already **subscr - Use this list for your HertzBeat questions - Used by HertzBeat contributors to discuss development of HertzBeat - -| List Name | Address | Subscribe | Unsubscribe | Archive | -|---------------------|------------------------------|------------------------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------| -| **Developer List** | dev@hertzbeat.apache.org | [subscribe](mailto:dev-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:dev-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | +| List Name | Address | Subscribe | Unsubscribe | Archive | +|--------------------|--------------------------|--------------------------------------------------------|------------------------------------------------------------|------------------------------------------------------------------------| +| **Developer List** | dev@hertzbeat.apache.org | [subscribe](mailto:dev-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:dev-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | ### Notification List - Notifications on changes to the HertzBeat codebase -| List Name | Address | Subscribe | Unsubscribe | Archive | -|-------------------------|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------| -| **Notification List** | notifications@hertzbeat.apache.org | [subscribe](mailto:notifications-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | +| List Name | Address | Subscribe | Unsubscribe | Archive | +|-----------------------|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------| +| **Notification List** | notifications@hertzbeat.apache.org | [subscribe](mailto:notifications-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | ## Steps for Subscription diff --git a/home/versioned_docs/version-v1.5.x/community/new_committer_process.md b/home/versioned_docs/version-v1.5.x/community/new_committer_process.md index b72ec6e30b7..0801f579000 100644 --- a/home/versioned_docs/version-v1.5.x/community/new_committer_process.md +++ b/home/versioned_docs/version-v1.5.x/community/new_committer_process.md @@ -5,20 +5,20 @@ sidebar_position: 4 --- [Apache New Committer Guideline](https://community.apache.org/newcommitter.html#new-committer-process) @@ -47,10 +47,9 @@ sidebar_position: 4 see **Committer Account Creation** - - Wait until root says it is done - - PMC Chair enables svn and other access - - Add committer to the appropriate groups in JIRA and CWiki - + - Wait until root says it is done + - PMC Chair enables svn and other access + - Add committer to the appropriate groups in JIRA and CWiki - Notify the committer of completion see **Committer Done Template** @@ -243,3 +242,4 @@ you can now help fix that. A PPMC member will announce your election to the dev list soon. ``` + diff --git a/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md b/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md index ebc84b92d67..414dad94a56 100644 --- a/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md +++ b/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md @@ -5,20 +5,20 @@ sidebar_position: 5 --- [Apache New Committer Guideline](https://community.apache.org/newcommitter.html#new-committer-process) @@ -81,7 +81,6 @@ ${Work list}[1] Note that, Voting ends one week from today, i.e. [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) [Apache Voting Guidelines](https://community.apache.org/newcommitter.html) - ### Close Vote Template ```text @@ -283,3 +282,4 @@ A PPMC member helps manage and guide the direction of the project. Thanks, On behalf of the Apache HertzBeat (incubating) PPMC ``` + diff --git a/home/versioned_docs/version-v1.5.x/community/submit-code.md b/home/versioned_docs/version-v1.5.x/community/submit-code.md index dfea1601d87..15bfeba545a 100644 --- a/home/versioned_docs/version-v1.5.x/community/submit-code.md +++ b/home/versioned_docs/version-v1.5.x/community/submit-code.md @@ -5,22 +5,21 @@ sidebar_position: 2 --- - * First from the remote repository fork a copy of the code into your own repository * The remote dev and merge branch is `master`. @@ -28,49 +27,44 @@ sidebar_position: 2 * Clone your repository to your local ```shell - git clone git@github.com:/hertzbeat.git +git clone git@github.com:/hertzbeat.git ``` * Add remote repository address, named upstream ```shell - git remote add upstream git@github.com:apache/hertzbeat.git +git remote add upstream git@github.com:apache/hertzbeat.git ``` * View repository ```shell - git remote -v +git remote -v ``` - > At this time, there will be two repositories: origin (your own repository) and upstream (remote repository) +> At this time, there will be two repositories: origin (your own repository) and upstream (remote repository) * Get/Update remote repository code - ```shell - git fetch upstream - ``` - + ```shell + git fetch upstream + ``` * Synchronize remote repository code to local repository - ```shell - git checkout origin/dev - git merge --no-ff upstream/dev - ``` - + ```shell + git checkout origin/dev + git merge --no-ff upstream/dev + ``` * **⚠️Note that you must create a new branch to develop features `git checkout -b feature-xxx`. It is not recommended to use the master branch for direct development** - * After modifying the code locally, submit it to your own repository: - **Note that the submission information does not contain special characters** - ```shell - git commit -m 'commit content' - git push - ``` + **Note that the submission information does not contain special characters** + ```shell + git commit -m 'commit content' + git push + ``` * Submit changes to the remote repository, you can see a green button "Compare & pull request" on your repository page, click it. - * Select the modified local branch and the branch you want to merge with the past, you need input the message carefully, describe doc is important as code, click "Create pull request". - * Then the community Committers will do CodeReview, and then he will discuss some details (design, implementation, performance, etc.) with you, afterward you can directly update the code in this branch according to the suggestions (no need to create a new PR). When this pr is approved, the commit will be merged into the master branch - * Finally, congratulations, you have become an official contributor to HertzBeat ! You will be added to the contributor wall, you can contact the community to obtain a contributor certificate. + diff --git a/home/versioned_docs/version-v1.5.x/download.md b/home/versioned_docs/version-v1.5.x/download.md index 2c0df07bb7c..355fed91be7 100644 --- a/home/versioned_docs/version-v1.5.x/download.md +++ b/home/versioned_docs/version-v1.5.x/download.md @@ -18,12 +18,10 @@ sidebar_label: Download Previous releases of HertzBeat may be affected by security issues, please use the latest one. ::: - -| Version | Date | Download | Release Notes | +| Version | Date | Download | Release Notes | |---------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| | v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | - ## All Archived Releases For older releases, please check the [archive](https://archive.apache.org/dist/incubator/hertzbeat/). @@ -34,3 +32,4 @@ For older releases, please check the [archive](https://archive.apache.org/dist/i - HertzBeat https://hub.docker.com/r/apache/hertzbeat - HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector + diff --git a/home/versioned_docs/version-v1.5.x/help/activemq.md b/home/versioned_docs/version-v1.5.x/help/activemq.md index 52e3090fde2..f24bc37fbbb 100644 --- a/home/versioned_docs/version-v1.5.x/help/activemq.md +++ b/home/versioned_docs/version-v1.5.x/help/activemq.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] **Use Protocol: JMX** -### Pre-monitoring Operations +### Pre-monitoring Operations > You need to enable the `JMX` service on ActiveMQ, HertzBeat uses the JMX protocol to collect metrics from ActiveMQ. @@ -26,6 +26,7 @@ keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics] 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" @@ -36,6 +37,7 @@ 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" @@ -52,7 +54,7 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" ### Configuration parameters -| Parameter name | Parameter help description | +| 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. | @@ -64,82 +66,81 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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 +### Collect Metrics #### metrics: broker -| Metric Name | Unit | Description | +| Metric Name | Unit | Description | |-------------------------|------|-----------------------------------------------------------------------| -| BrokerName | None | The name of the broker. | -| BrokerVersion | None | The version of the broker. | -| Uptime | None | Uptime of the broker. | +| 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. | +| 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 | - +| 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 | +| 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 | - +| 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 | +| 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.5.x/help/airflow.md b/home/versioned_docs/version-v1.5.x/help/airflow.md index 5323ede8110..52367155d89 100644 --- a/home/versioned_docs/version-v1.5.x/help/airflow.md +++ b/home/versioned_docs/version-v1.5.x/help/airflow.md @@ -9,33 +9,31 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8080 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| HTTPS | 是否启用HTTPS | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：airflow_health -| 指标名称 | 指标单位 | 指标帮助描述 | -| ------------ | -------- | -------------------- | -| metadatabase | 无 | metadatabase健康情况 | -| scheduler | 无 | scheduler健康情况 | -| triggerer | 无 | triggerer健康情况 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|------------------| +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | #### 指标集合：airflow_version -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | -------- | --------------- | -| value | 无 | Airflow版本 | -| git_version | 无 | Airflow git版本 | - - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|---------------| +| value | 无 | Airflow版本 | +| git_version | 无 | Airflow git版本 | diff --git a/home/versioned_docs/version-v1.5.x/help/alert_console.md b/home/versioned_docs/version-v1.5.x/help/alert_console.md index e727fec4771..45ab7d791d3 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_console.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_console.md @@ -6,13 +6,13 @@ 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. \ No newline at end of file +The default value is the official console address of HertzBeat. diff --git a/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md b/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md index fb63d52aa48..b86ed662940 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md @@ -5,15 +5,15 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by DingDing robot. -### Operation steps +### 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. +> 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) +![email](/img/docs/help/alert-notice-8.png) 2. **【Save access_token value of the WebHook address of the robot】** @@ -24,18 +24,18 @@ keywords: [open source monitoring tool, open source alerter, open source DingDin ![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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### DingDing robot common issues -### DingDing robot common issues +1. DingDing group did not receive the robot alarm notification. -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_discord.md b/home/versioned_docs/version-v1.5.x/help/alert_discord.md index 8dfdca384fa..7aa565c0acf 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_discord.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_discord.md @@ -45,7 +45,6 @@ keywords: [open source monitoring tool, open source alerter, open source Discord ![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]** @@ -58,13 +57,12 @@ keywords: [open source monitoring tool, open source alerter, open source Discord ![email](/img/docs/help/alert-notice-policy.png) +### Discord Bot Notification FAQ -### Discord Bot Notification FAQ - -1. Discord doesn't receive bot alert notifications +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 +> Please check whether the bot is properly authorized by the Discord chat server Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_email.md b/home/versioned_docs/version-v1.5.x/help/alert_email.md index 353ae4673fe..fb6dc7fa571 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_email.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_email.md @@ -5,34 +5,35 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by email. -### Operation steps +### Operation steps -1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** +1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】** -![email](/img/docs/help/alert-notice-1.png) +![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-2.png) -![email](/img/docs/help/alert-notice-3.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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### Email notification common issues -### Email notification common issues +1. Hertzbeat deployed on its own intranet cannot receive email notifications -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 +> 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 -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. +> 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.5.x/help/alert_enterprise_wechat_app.md b/home/versioned_docs/version-v1.5.x/help/alert_enterprise_wechat_app.md index f9e072e436a..1d5d41a15bc 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_enterprise_wechat_app.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_enterprise_wechat_app.md @@ -5,30 +5,30 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by enterprise WeChat App. -### Operation steps +### 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) +![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】** +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.** +> **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) +![email](/img/docs/help/alert-wechat-3.jpg) +### Enterprise WeChat App common issues -### Enterprise WeChat App common issues +1. Enterprise WeChat App did not receive the alarm notification. -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_feishu.md b/home/versioned_docs/version-v1.5.x/help/alert_feishu.md index 56606012021..8f7e9391001 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_feishu.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_feishu.md @@ -5,30 +5,30 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by FeiShu robot. -### Operation steps +### 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】** +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` +> 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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) +### FeiShu robot notification common issues -### FeiShu robot notification common issues +1. FeiShu group did not receive the robot alarm notification. -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. +> 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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_slack.md b/home/versioned_docs/version-v1.5.x/help/alert_slack.md index 2540a27451d..5148432fe8b 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_slack.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_slack.md @@ -25,12 +25,11 @@ Refer to the official website document [Sending messages using Incoming Webhooks ![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 +> Please check whether the slack webhook url are configured correctly, and whether the alarm policy association has been configured Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_telegram.md b/home/versioned_docs/version-v1.5.x/help/alert_telegram.md index 1fbe4f0ae7e..cb60f266778 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_telegram.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_telegram.md @@ -54,13 +54,12 @@ Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token ![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 +> UserId should be the UserId of the recipient of the message Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_threshold.md b/home/versioned_docs/version-v1.5.x/help/alert_threshold.md index 0574b1924ba..2619fdbcf6e 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_threshold.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_threshold.md @@ -3,6 +3,7 @@ id: alert_threshold title: Threshold Alert Configuration sidebar_label: Threshold Alert Configuration --- + > Configure alert thresholds for monitoring metrics (warning alert, critical alert, emergency alert). The system triggers alerts based on threshold configuration and collected metric data. ## Operational Steps diff --git a/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md b/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md index a7a7e6bdbe0..6b8772388e6 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md @@ -8,40 +8,40 @@ sidebar_label: Threshold Trigger Expression #### Supported Operators in Expressions -| Operator (Visual Configuration) | Operator (Expression Configuration) | Supported Types | Description | -| ------------------------------- | ----------------------------------- | ------------------------- | -------------------------- | -| Equals | equals(str1,str2) | String | Check if strings are equal | -| Not Equals | !equals(str1,str2) | String | Check if strings are not equal | -| Contains | contains(str1,str2) | String | Check if string contains | -| Not Contains | !contains(str1,str2) | String | Check if string does not contain | -| Matches | matches(str1,str2) | String | Check if string matches regex | -| Not Matches | !matches(str1,str2) | String | Check if string does not match regex | -| Exists | exists(obj) | String, Numeric, Time | Check if value exists | -| Not Exists | !exists(obj) | String, Numeric, Time | Check if value does not exist | -| Greater than | obj1 > obj2 | Numeric, Time | Check if value is greater than | -| Less than | obj1 < obj2 | Numeric, Time | Check if value is less than | -| Greater than or Equal to | obj1 >= obj2 | Numeric, Time | Check if value is greater than or equal to | -| Less than or Equal to | obj1 <= obj2 | Numeric, Time | Check if value is less than or equal to | -| Not Equal to | obj1 != obj2 | Numeric, Time | Check if values are not equal | -| Equal to | obj1 == obj2 | Numeric, Time | Check if values are equal | +| Operator (Visual Configuration) | Operator (Expression Configuration) | Supported Types | Description | +|---------------------------------|-------------------------------------|-----------------------|--------------------------------------------| +| Equals | equals(str1,str2) | String | Check if strings are equal | +| Not Equals | !equals(str1,str2) | String | Check if strings are not equal | +| Contains | contains(str1,str2) | String | Check if string contains | +| Not Contains | !contains(str1,str2) | String | Check if string does not contain | +| Matches | matches(str1,str2) | String | Check if string matches regex | +| Not Matches | !matches(str1,str2) | String | Check if string does not match regex | +| Exists | exists(obj) | String, Numeric, Time | Check if value exists | +| Not Exists | !exists(obj) | String, Numeric, Time | Check if value does not exist | +| Greater than | obj1 > obj2 | Numeric, Time | Check if value is greater than | +| Less than | obj1 < obj2 | Numeric, Time | Check if value is less than | +| Greater than or Equal to | obj1 >= obj2 | Numeric, Time | Check if value is greater than or equal to | +| Less than or Equal to | obj1 <= obj2 | Numeric, Time | Check if value is less than or equal to | +| Not Equal to | obj1 != obj2 | Numeric, Time | Check if values are not equal | +| Equal to | obj1 == obj2 | Numeric, Time | Check if values are equal | #### Expression Function Library List -| Supported Function Library | Description | -| -------------------------------- | -------------------------------------------------------------- | -| condition ? trueExpression : falseExpression | Ternary operator | -| toDouble(str) | Convert string to Double type | -| toBoolean(str) | Convert string to Boolean type | -| toInteger(str) | Convert string to Integer type | -| array[n] | Retrieve the nth element of an array | -| * | Multiplication | -| / | Division | -| % | Modulo | -| ( and ) | Parentheses for controlling the order of operations in logical or mathematical expressions | -| + | Addition | -| - | Subtraction | -| && | Logical AND operator | -| \|\| | Logical OR operator | +| Supported Function Library | Description | +|----------------------------------------------|--------------------------------------------------------------------------------------------| +| condition ? trueExpression : falseExpression | Ternary operator | +| toDouble(str) | Convert string to Double type | +| toBoolean(str) | Convert string to Boolean type | +| toInteger(str) | Convert string to Integer type | +| array[n] | Retrieve the nth element of an array | +| * | Multiplication | +| / | Division | +| % | Modulo | +| ( and ) | Parentheses for controlling the order of operations in logical or mathematical expressions | +| + | Addition | +| - | Subtraction | +| && | Logical AND operator | +| \|\| | Logical OR operator | #### Supported Environment Variables @@ -63,4 +63,4 @@ This variable is mainly used for calculations involving multiple instances. For 4. MYSQL Monitoring -> Alert when 'threads_running' metric under 'status' exceeds 7 `threads_running>7` -If you encounter any issues, feel free to discuss and provide feedback through our community group or ISSUE tracker! \ No newline at end of file +If you encounter any issues, feel free to discuss and provide feedback through our community group or ISSUE tracker! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_webhook.md b/home/versioned_docs/version-v1.5.x/help/alert_webhook.md index adc1b6f12f8..d1741d71481 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_webhook.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_webhook.md @@ -5,23 +5,24 @@ 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. +> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient. -### Operation steps +### Operation steps -1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】** +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】** +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.** +> **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](/img/docs/help/alert-notice-4.png) -### WebHook callback POST body BODY content +### WebHook callback POST body BODY content + +Content format：JSON -Content format：JSON ```json { "alarmId": 76456, @@ -43,24 +44,23 @@ Content format：JSON } ``` -| | | -|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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} | - +| | | +|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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 -### Webhook notification common issues +1. WebHook callback did not take effect -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! +Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_wework.md b/home/versioned_docs/version-v1.5.x/help/alert_wework.md index e862fae7ddf..ca14d5615fa 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_wework.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_wework.md @@ -5,34 +5,34 @@ 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. +> After the threshold is triggered send alarm information and notify the recipient by enterprise Wechat robot. -### Operation steps +### Operation steps -1. **【Enterprise Wechat】-> 【Group settings】-> 【Group robot】-> 【Add new robot】-> 【Set robot name and avatar】-> 【Copy its webhook address after adding successfully】** +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) +![email](/img/docs/help/alert-notice-6.jpg) -2. **【Save the key value of the WebHook address of the robot】** +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` +> 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】** +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】** +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) +> **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. +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. +> Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/almalinux.md b/home/versioned_docs/version-v1.5.x/help/almalinux.md index 380e1439ab4..40a07028c96 100644 --- a/home/versioned_docs/version-v1.5.x/help/almalinux.md +++ b/home/versioned_docs/version-v1.5.x/help/almalinux.md @@ -4,14 +4,14 @@ title: Monitoring AlmaLinux Operating System Monitoring sidebar_label: AlmaLinux Operating System keywords: [open-source monitoring system, open-source operating system monitoring, AlmaLinux operating system monitoring] --- + > Collect and monitor common performance metrics of the AlmaLinux operating system. ### Configuration Parameters - -| Parameter Name | Parameter Help Description | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note ⚠️ No protocol header (e.g., https://, http://). | +| Parameter Name | Parameter Help Description | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note ⚠️ No protocol header (e.g., https://, http://). | | Task Name | A unique name to identify this monitoring task. | | Port | The port provided by Linux SSH, default is 22. | | Timeout | Set the connection timeout in milliseconds, default is 6000 ms. | @@ -28,18 +28,16 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Basic System Information - -| Metric Name | Metric Unit | Metric Help Description | -| -------------- | ----------- | ------------------------ | +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|--------------------------| | Host Name | None | Host name | | System Version | None | Operating system version | | Uptime | None | Uptime | #### Metric Set: CPU Information - -| Metric Name | Metric Unit | Metric Help Description | -| -------------- | ----------- | --------------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|-----------------------------------| | info | None | CPU model | | cores | Cores | Number of CPU cores | | interrupt | Count | Number of CPU interrupts | @@ -49,9 +47,8 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Memory Information - -| Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|-------------------------------------| | total | Mb | Total memory capacity | | used | Mb | Memory used by user programs | | free | Mb | Free memory capacity | @@ -61,9 +58,8 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Disk Information - -| Metric Name | Metric Unit | Metric Help Description | -| ------------- | ----------- | -------------------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|----------------------------------------| | disk_num | Count | Total number of disks | | partition_num | Count | Total number of partitions | | block_write | Blocks | Total number of blocks written to disk | @@ -72,18 +68,16 @@ keywords: [open-source monitoring system, open-source operating system monitorin #### Metric Set: Network Card Information - -| Metric Name | Metric Unit | Metric Help Description | -| -------------- | ----------- | ----------------------------- | +| Metric Name | Metric Unit | Metric Help Description | +|----------------|-------------|-------------------------------| | interface_name | None | Network card name | | receive_bytes | Byte | Inbound data traffic (bytes) | | transmit_bytes | Byte | Outbound data traffic (bytes) | #### Metric Set: File System - | Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | filesystem | None | Name of the file system | | used | Mb | Used disk size | | available | Mb | Available disk size | @@ -94,9 +88,8 @@ keywords: [open-source monitoring system, open-source operating system monitorin Statistics for the top 10 processes using the CPU. Statistics include: process ID, CPU usage, memory usage, and executed command. - | Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | pid | None | Process ID | | cpu_usage | % | CPU usage | | mem_usage | % | Memory usage | @@ -106,12 +99,12 @@ Statistics for the top 10 processes using the CPU. Statistics include: process I Statistics for the top 10 processes using memory. Statistics include: process ID, memory usage, CPU usage, and executed command. - | Metric Name | Metric Unit | Metric Help Description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | pid | None | Process ID | | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | --- + diff --git a/home/versioned_docs/version-v1.5.x/help/api.md b/home/versioned_docs/version-v1.5.x/help/api.md index f9a0a60d390..98763e0eefe 100644 --- a/home/versioned_docs/version-v1.5.x/help/api.md +++ b/home/versioned_docs/version-v1.5.x/help/api.md @@ -5,33 +5,33 @@ 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. +> 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 | -| Headers | HTTP request headers | -| Params | HTTP query params, support [time expression](time_expression) | -| Content-Type | Set the resource type when carrying the BODY request body data request | -| Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| 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 | +| 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 | +| Headers | HTTP request headers | +| Params | HTTP query params, support [time expression](time_expression) | +| Content-Type | Set the resource type when carrying the BODY request body data request | +| Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| 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 +### Collection Metric -#### Metric set：summary +#### Metric set：summary -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| responseTime | ms | Website response time | +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | diff --git a/home/versioned_docs/version-v1.5.x/help/centos.md b/home/versioned_docs/version-v1.5.x/help/centos.md index 2a6ad2b0a6d..60b770ebf96 100644 --- a/home/versioned_docs/version-v1.5.x/help/centos.md +++ b/home/versioned_docs/version-v1.5.x/help/centos.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source os monitoring tool, monitori ### 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 | +| 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 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 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 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 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 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 | +| 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.5.x/help/clickhouse.md b/home/versioned_docs/version-v1.5.x/help/clickhouse.md index 3e09687a450..efd873d1f32 100644 --- a/home/versioned_docs/version-v1.5.x/help/clickhouse.md +++ b/home/versioned_docs/version-v1.5.x/help/clickhouse.md @@ -4,91 +4,93 @@ title: Monitoring ClickHouse Database Monitoring sidebar_label: ClickHouse Database keywords: [open source monitoring system, open source database monitoring, ClickHouse database monitoring] --- + > Collect and monitor general performance metrics for the ClickHouse database. ### Configuration Parameters -| Parameter Name | Parameter Description | -| -------------- | ------------------------------------------------------------------------- | -| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). | -| Task Name | Name identifying this monitoring, ensuring uniqueness. | -| Port | Port number of the database exposed to the outside, default is 8123. | -| Query Timeout | Timeout for SQL queries to respond, in milliseconds (ms), default is 6000ms. | -| Database Name | Name of the database instance, optional. | -| Username | Username for database connection, optional. | -| Password | Password for database connection, optional. | -| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. | -| Tag Binding | Used for categorizing and managing monitored resources. | -| Description | Additional information to identify and describe this monitoring, where users can add remarks. | +| Parameter Name | Parameter Description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). | +| Task Name | Name identifying this monitoring, ensuring uniqueness. | +| Port | Port number of the database exposed to the outside, default is 8123. | +| Query Timeout | Timeout for SQL queries to respond, in milliseconds (ms), default is 6000ms. | +| Database Name | Name of the database instance, optional. | +| Username | Username for database connection, optional. | +| Password | Password for database connection, optional. | +| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. | +| Tag Binding | Used for categorizing and managing monitored resources. | +| Description | Additional information to identify and describe this monitoring, where users can add remarks. | ### Collected Metrics #### Metric Set: ping Availability -| Metric Name | Metric Unit | Metric Description | -| ------------- | ----------- | ------------------ | -| responseTime | N/A | Response time | +| Metric Name | Metric Unit | Metric Description | +|--------------|-------------|--------------------| +| responseTime | N/A | Response time | #### Metric Set: Data from system.metrics table -| Metric Name | Metric Unit | Metric Description | -| ---------------------- | ----------- | ------------------------------------------------------------- | -| Query | N/A | Number of queries being executed | -| Merge | N/A | Number of background merges being executed | -| Move | N/A | Number of background moves being executed | -| PartMutation | N/A | Number of table mutations | -| ReplicatedFetch | N/A | Number of data blocks fetched from replicas | -| ReplicatedSend | N/A | Number of data blocks sent to replicas | -| ReplicatedChecks | N/A | Number of consistency checks on data blocks | -| QueryPreempted | N/A | Number of queries stopped or waiting | -| TCPConnection | N/A | Number of TCP connections | -| HTTPConnection | N/A | Number of HTTP connections | -| OpenFileForRead | N/A | Number of open readable files | -| OpenFileForWrite | N/A | Number of open writable files | -| QueryThread | N/A | Number of threads processing queries | -| ReadonlyReplica | N/A | Number of Replicated tables in read-only state | -| EphemeralNode | N/A | Number of ephemeral nodes in ZooKeeper | -| ZooKeeperWatch | N/A | Number of ZooKeeper event subscriptions | -| StorageBufferBytes | Bytes | Bytes in Buffer tables | -| VersionInteger | N/A | ClickHouse version number | -| RWLockWaitingReaders | N/A | Number of threads waiting for read-write lock on a table | -| RWLockWaitingWriters | N/A | Number of threads waiting for write lock on a table | -| RWLockActiveReaders | N/A | Number of threads holding read lock on a table | -| RWLockActiveWriters | N/A | Number of threads holding write lock on a table | -| GlobalThread | N/A | Number of threads in global thread pool | -| GlobalThreadActive | N/A | Number of active threads in global thread pool | -| LocalThread | N/A | Number of threads in local thread pool | -| LocalThreadActive | N/A | Number of active threads in local thread pool | +| Metric Name | Metric Unit | Metric Description | +|----------------------|-------------|----------------------------------------------------------| +| Query | N/A | Number of queries being executed | +| Merge | N/A | Number of background merges being executed | +| Move | N/A | Number of background moves being executed | +| PartMutation | N/A | Number of table mutations | +| ReplicatedFetch | N/A | Number of data blocks fetched from replicas | +| ReplicatedSend | N/A | Number of data blocks sent to replicas | +| ReplicatedChecks | N/A | Number of consistency checks on data blocks | +| QueryPreempted | N/A | Number of queries stopped or waiting | +| TCPConnection | N/A | Number of TCP connections | +| HTTPConnection | N/A | Number of HTTP connections | +| OpenFileForRead | N/A | Number of open readable files | +| OpenFileForWrite | N/A | Number of open writable files | +| QueryThread | N/A | Number of threads processing queries | +| ReadonlyReplica | N/A | Number of Replicated tables in read-only state | +| EphemeralNode | N/A | Number of ephemeral nodes in ZooKeeper | +| ZooKeeperWatch | N/A | Number of ZooKeeper event subscriptions | +| StorageBufferBytes | Bytes | Bytes in Buffer tables | +| VersionInteger | N/A | ClickHouse version number | +| RWLockWaitingReaders | N/A | Number of threads waiting for read-write lock on a table | +| RWLockWaitingWriters | N/A | Number of threads waiting for write lock on a table | +| RWLockActiveReaders | N/A | Number of threads holding read lock on a table | +| RWLockActiveWriters | N/A | Number of threads holding write lock on a table | +| GlobalThread | N/A | Number of threads in global thread pool | +| GlobalThreadActive | N/A | Number of active threads in global thread pool | +| LocalThread | N/A | Number of threads in local thread pool | +| LocalThreadActive | N/A | Number of active threads in local thread pool | #### Metric Set: Data from system.events table -| Metric Name | Metric Unit | Metric Description | -| ------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- | -| Query | N/A | Number of queries to parse and possibly execute. Excludes queries rejected due to AST size limits, quota limits, or simultaneous query limits. May include internal queries initiated by ClickHouse. Subqueries are not counted. | -| SelectQuery | N/A | Number of Select queries possibly executed | -| InsertQuery | N/A | Number of Insert queries possibly executed | -| InsertedRows | N/A | Number of rows inserted into all tables | -| InsertedBytes | Bytes | Number of bytes inserted into all tables | -| FailedQuery | N/A | Number of failed queries | -| FailedSelectQuery | N/A | Number of failed Select queries | -| FileOpen | N/A | Number of file openings | -| MergeTreeDataWriterRows | N/A | Number of data rows written to MergeTree tables | -| MergeTreeDataWriterCompressedBytes | Bytes | Number of compressed data bytes written to MergeTree tables | +| Metric Name | Metric Unit | Metric Description | +|------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Query | N/A | Number of queries to parse and possibly execute. Excludes queries rejected due to AST size limits, quota limits, or simultaneous query limits. May include internal queries initiated by ClickHouse. Subqueries are not counted. | +| SelectQuery | N/A | Number of Select queries possibly executed | +| InsertQuery | N/A | Number of Insert queries possibly executed | +| InsertedRows | N/A | Number of rows inserted into all tables | +| InsertedBytes | Bytes | Number of bytes inserted into all tables | +| FailedQuery | N/A | Number of failed queries | +| FailedSelectQuery | N/A | Number of failed Select queries | +| FileOpen | N/A | Number of file openings | +| MergeTreeDataWriterRows | N/A | Number of data rows written to MergeTree tables | +| MergeTreeDataWriterCompressedBytes | Bytes | Number of compressed data bytes written to MergeTree tables | #### Metric Set: Data from system.asynchronous_metrics table -| Metric Name | Metric Unit | Metric Description | -| -------------------------------------- | ----------- | -------------------------------------- | -| AsynchronousMetricsCalculationTimeSpent | N/A | Time spent calculating asynchronous metrics (seconds) | -| jemalloc.arenas.all.muzzy_purged | N/A | Number of purged muzzy pages | -| jemalloc.arenas.all.dirty_purged | N/A | Number of purged dirty pages | -| BlockReadBytes_ram1 | N/A | Number of bytes read from ram1 block | -| jemalloc.background_thread.run_intervals | N/A | Number of intervals jemalloc background thread ran | -| BlockQueueTime_nbd13 | N/A | Queue wait time for nbd13 block | -| jemalloc.background_thread.num_threads | N/A | Number of jemalloc background threads | -| jemalloc.resident | N/A | Physical memory size allocated by jemalloc (bytes) | -| InterserverThreads | N/A | Number of Interserver threads | -| BlockWriteMerges_nbd7 | N/A | Number of block write merges for nbd7 block | -| MarkCacheBytes | N/A | Size of marks cache in StorageMergeTree | -| MarkCacheFiles | N/A | Number of files in marks cache for StorageMergeTree | -| MaxPartCountForPartition | N/A | Maximum active data blocks in partitions | \ No newline at end of file +| Metric Name | Metric Unit | Metric Description | +|------------------------------------------|-------------|-------------------------------------------------------| +| AsynchronousMetricsCalculationTimeSpent | N/A | Time spent calculating asynchronous metrics (seconds) | +| jemalloc.arenas.all.muzzy_purged | N/A | Number of purged muzzy pages | +| jemalloc.arenas.all.dirty_purged | N/A | Number of purged dirty pages | +| BlockReadBytes_ram1 | N/A | Number of bytes read from ram1 block | +| jemalloc.background_thread.run_intervals | N/A | Number of intervals jemalloc background thread ran | +| BlockQueueTime_nbd13 | N/A | Queue wait time for nbd13 block | +| jemalloc.background_thread.num_threads | N/A | Number of jemalloc background threads | +| jemalloc.resident | N/A | Physical memory size allocated by jemalloc (bytes) | +| InterserverThreads | N/A | Number of Interserver threads | +| BlockWriteMerges_nbd7 | N/A | Number of block write merges for nbd7 block | +| MarkCacheBytes | N/A | Size of marks cache in StorageMergeTree | +| MarkCacheFiles | N/A | Number of files in marks cache for StorageMergeTree | +| MaxPartCountForPartition | N/A | Maximum active data blocks in partitions | + diff --git a/home/versioned_docs/version-v1.5.x/help/debian.md b/home/versioned_docs/version-v1.5.x/help/debian.md index 65940c34a39..14cee060aaf 100644 --- a/home/versioned_docs/version-v1.5.x/help/debian.md +++ b/home/versioned_docs/version-v1.5.x/help/debian.md @@ -4,13 +4,13 @@ title: Monitoring Debian System Monitoring sidebar_label: Debian keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Monitoring] --- + > Collect and monitor general performance metrics of the Debian system. ## Configuration Parameters - -| Parameter Name | Metric help description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Metric help description | +|-------------------------|-------------------------------------------------------------------------------------------------------------------| | Target Host | The monitored destination IPV4, IPV6, or domain name. Note: no protocol header (e.g., https://, http://). | | Task Name | A unique name to identify this monitoring task. | | Port | SSH port of the Debian system, default: 22 | @@ -28,18 +28,16 @@ keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Mo #### Metric Set: Basic System Information - -| Metric Name | Metric Unit | Metric help description | -| -------------- | ----------- | ------------------------ | +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|--------------------------| | Host Name | N/A | Host name | | System Version | N/A | Operating system version | | Uptime | N/A | Boot time | #### Metric Set: CPU Information - -| Metric Name | Metric Unit | Metric help description | -| -------------- | ----------- | ----------------------- | +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|-------------------------| | Info | N/A | Model | | Cores | N/A | Number of cores | | Interrupt | N/A | Number of interrupts | @@ -49,9 +47,8 @@ keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Mo #### Metric Set: Memory Information - -| Metric Name | Metric Unit | Metric help description | -| ------------------- | ----------- | ---------------------------- | +| Metric Name | Metric Unit | Metric help description | +|---------------------|-------------|------------------------------| | Total Memory | Mb | Total memory capacity | | User Program Memory | Mb | Memory used by user programs | | Free Memory | Mb | Free memory capacity | @@ -61,9 +58,8 @@ keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Mo #### Metric Set: Disk Information - -| Metric Name | Metric Unit | Metric help description | -| ------------- | ----------- | ----------------------------- | +| Metric Name | Metric Unit | Metric help description | +|---------------|-------------|-------------------------------| | Disk Num | N/A | Total number of disks | | Partition Num | N/A | Total number of partitions | | Block Write | N/A | Number of disk blocks written | @@ -99,3 +95,4 @@ Metric Unit: - Memory Usage Rate: % - CPU Usage Rate: % + diff --git a/home/versioned_docs/version-v1.5.x/help/dm.md b/home/versioned_docs/version-v1.5.x/help/dm.md index 91b032fdf54..82159bf2408 100644 --- a/home/versioned_docs/version-v1.5.x/help/dm.md +++ b/home/versioned_docs/version-v1.5.x/help/dm.md @@ -9,41 +9,41 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | +| 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.5.x/help/dns.md b/home/versioned_docs/version-v1.5.x/help/dns.md index 7587452c1a7..d8dbd8d0921 100644 --- a/home/versioned_docs/version-v1.5.x/help/dns.md +++ b/home/versioned_docs/version-v1.5.x/help/dns.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -28,7 +28,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito #### Metrics Set：Header -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|---------------------------------------------------| | Response Time | ms | Time taken for DNS server to respond to requests. | | Opcode | none | Type of the current message. | @@ -41,13 +41,13 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Metrics Set: Question -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------| | Section | none | Question record information, including the queried domain name, resource type, resource record class, and additional information. | ### Metrics Set: Answer -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|----------------------------------------------------------------------------------------------------------------------------| | Section0 | none | Answer record information, including the queried domain name, TTL, resource record class, resource type, and query result. | @@ -55,7 +55,7 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Metrics Set: Authority -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| | Section0 | none | SOA (Start of Authority) record for the domain name, including queried domain name, TTL, resource type, resource record class, and other information. | @@ -63,8 +63,9 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito ### Metrics Set: Additional -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-----------------------------------------| | Section0 | none | Additional information for DNS queries. | > The metric set collects up to 10 records, with metric names from Section0 to Section9. + diff --git a/home/versioned_docs/version-v1.5.x/help/docker.md b/home/versioned_docs/version-v1.5.x/help/docker.md index fdd3098ce55..0e3a1f0b428 100644 --- a/home/versioned_docs/version-v1.5.x/help/docker.md +++ b/home/versioned_docs/version-v1.5.x/help/docker.md @@ -7,7 +7,6 @@ keywords: [open source monitoring tool, open source docker monitoring tool, moni > 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. @@ -31,7 +30,7 @@ This is equivalent to the **2375** port that is open to the outside world. Of co ```shell systemctl daemon-reload systemctl restart docker -```` +``` **Note: Remember to open the `2375` port number in the server console. ** @@ -42,65 +41,62 @@ 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 | +| 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 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 | +| 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 | +| 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.5.x/help/doris_be.md b/home/versioned_docs/version-v1.5.x/help/doris_be.md index 2bc212ef3fb..8dcde7b549b 100644 --- a/home/versioned_docs/version-v1.5.x/help/doris_be.md +++ b/home/versioned_docs/version-v1.5.x/help/doris_be.md @@ -9,162 +9,163 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ------------ | ------------------------------------------------------------ | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | -| 端口 | 数据库对外提供的端口，默认为8040 | -| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | -| 数据库名称 | 数据库实例名称，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称，名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口，默认为8040 | +| 查询超时时间 | 设置连接未响应的超时时间，单位ms毫秒，默认3000毫秒 | +| 数据库名称 | 数据库实例名称，可选 | +| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | ### 采集指标 #### 指标集合：doris_be_load_channel_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| value | 无 | 当前打开的 load channel 个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------------| +| value | 无 | 当前打开的 load channel 个数 | #### 指标集合：doris_be_memtable_flush_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------------- | -| value | 无 | memtable写入磁盘的个数累计值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | memtable写入磁盘的个数累计值 | #### 指标集合：doris_be_plan_fragment_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------- | -| value | 无 | 当前已接收的 fragment instance 的数量 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------| +| value | 无 | 当前已接收的 fragment instance 的数量 | #### 指标集合：doris_be_process_thread_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------- | -| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | #### 指标集合：doris_be_query_scan_rows -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------------ | -| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------------------------------------------| +| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead（部分数据行可能被索引跳过，并没有真正读取，但仍会记录到这个值中） | #### 指标集合：doris_be_result_buffer_block_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------- | -| value | 无 | 当前查询结果缓存中的 query 个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 当前查询结果缓存中的 query 个数 | #### 指标集合：doris_be_send_batch_thread_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------------- | -| value | 无 | 导入时用于发送数据包的线程池的排队个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------| +| value | 无 | 导入时用于发送数据包的线程池的排队个数 | #### 指标集合：doris_be_tablet_base_max_compaction_score -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------------- | -| value | 无 | 当前最大的 Base Compaction Score | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------------------| +| value | 无 | 当前最大的 Base Compaction Score | #### 指标集合：doris_be_timeout_canceled_fragment_count -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------------------- | -| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------------| +| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | #### 指标集合：doris_be_load_rows -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------- | -| value | 无 | 通过 tablet sink 发送的行数累计 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------| +| value | 无 | 通过 tablet sink 发送的行数累计 | #### 指标集合：doris_be_all_rowsets_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ---------------------- | -| value | 无 | 当前所有 rowset 的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| value | 无 | 当前所有 rowset 的个数 | #### 指标集合：doris_be_all_segments_num -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------- | -| value | 无 | 当前所有 segment 的个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------| +| value | 无 | 当前所有 segment 的个数 | #### 指标集合：doris_be_heavy_work_max_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------ | -| value | 无 | brpc heavy线程池线程个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | brpc heavy线程池线程个数 | #### 指标集合：doris_be_light_work_max_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------ | -| value | 无 | brpc light线程池线程个数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-------------------| +| value | 无 | brpc light线程池线程个数 | #### 指标集合：doris_be_heavy_work_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------------- | -| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | #### 指标集合：doris_be_light_work_pool_queue_size -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ----------------------------------------------- | -| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|---------------------------------| +| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | #### 指标集合：doris_be_heavy_work_active_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------- | -| value | 无 | brpc heavy线程池活跃线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | brpc heavy线程池活跃线程数 | #### 指标集合：doris_be_light_work_active_threads -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | -------------------------- | -| value | 无 | brpc light线程池活跃线程数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| value | 无 | brpc light线程池活跃线程数 | #### 指标集合：doris_be_compaction_bytes_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| ---------- | -------- | ---------------------------------- | -| base | 字节 | Base Compaction 的数据量累计 | -| cumulative | 字节 | Cumulative Compaction 的数据量累计 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|------------------------------| +| base | 字节 | Base Compaction 的数据量累计 | +| cumulative | 字节 | Cumulative Compaction 的数据量累计 | #### 指标集合：doris_be_disks_avail_capacity -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------- | -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------| +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | #### 指标集合：doris_be_disks_total_capacity -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | ------------------------------------------------------- | -| path | 无 | 指定数据目录 | -| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------------------------------| +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | #### 指标集合：doris_be_local_bytes_read_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------- | -| value | 字节 | 由 `LocalFileReader` 读取的字节数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------| +| value | 字节 | 由 `LocalFileReader` 读取的字节数 | #### 指标集合：doris_be_local_bytes_written_total -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------- | -| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|----------------------------| +| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | #### 指标集合：doris_be_memory_allocated_bytes -| 指标名称 | 指标单位 | 指标帮助描述 | -| -------- | -------- | --------------------------------------------------- | -| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------------------------------------| +| value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | + diff --git a/home/versioned_docs/version-v1.5.x/help/doris_fe.md b/home/versioned_docs/version-v1.5.x/help/doris_fe.md index bb7a6b99d53..b478b2eaadb 100644 --- a/home/versioned_docs/version-v1.5.x/help/doris_fe.md +++ b/home/versioned_docs/version-v1.5.x/help/doris_fe.md @@ -4,6 +4,7 @@ title: Monitoring DORIS Database FE Monitoring sidebar_label: DORIS Database FE keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database FE Monitoring] --- + > Collect and monitor general performance metrics for DORIS database FE. Supports DORIS 2.0.0. **Protocol: HTTP** @@ -14,9 +15,8 @@ Check the `fe/conf/fe.conf` file to obtain the value of the `http_port` configur ### Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Parameter Description | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Monitor Host | The monitored target's IPV4, IPV6, or domain name. Note: Without the protocol header (e.g., https://, http://) | | Task Name | A unique name identifying this monitoring task | | Port | The port provided by the database to the outside, default is 8030 ,get the value of the`http_port` configuration item | @@ -30,26 +30,23 @@ Check the `fe/conf/fe.conf` file to obtain the value of the `http_port` configur #### Metric Set: doris_fe_connection_total - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------| | value | None | The current number of MySQL port connections on FE | #### Metric Set: doris_fe_edit_log_clean Should not fail; if it does, manual intervention is required. - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|---------------------------------------------------------------| | success | None | The number of successful cleanups of historical metadata logs | | failed | None | The number of failed cleanups of historical metadata logs | #### Metric Set: doris_fe_edit_log - -| Metric Name | Metric Unit | Metric help description | -| ----------------- | ----------- | ------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------------|-------------|---------------------------------------------| | write | None | The count of metadata log write operations | | read | None | The count of metadata log read operations | | current | None | The current number of metadata logs | @@ -60,9 +57,8 @@ Should not fail; if it does, manual intervention is required. Should not fail; if it does, manual intervention is required. - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------| | success | None | The number of successful cleanups of historical metadata image files | | failed | None | The number of failed cleanups of historical metadata image files | @@ -70,77 +66,68 @@ Should not fail; if it does, manual intervention is required. Should not fail; if it does, manual intervention is required. - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------ | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------------------------------| | success | None | The number of successful generations of metadata image files | | failed | None | The number of failed generations of metadata image files | #### Metric Set: doris_fe_query_err - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ----------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------------------------| | value | None | The cumulative value of erroneous queries | #### Metric Set: doris_fe_max_journal_id - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The current maximum metadata log ID on the FE node. If it is a Master FE, it is the maximum ID currently written; if it is a non-Master FE, it represents the maximum metadata log ID currently being replayed. Used to observe if there is a large gap between the IDs of multiple FEs. A large gap indicates issues with metadata synchronization | #### Metric Set: doris_fe_max_tablet_compaction_score - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The largest compaction score value among all BE nodes. This value can observe the current cluster's maximum compaction score to judge if it is too high. If too high, there may be delays in queries or writes | #### Metric Set: doris_fe_qps - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|---------------------------------------------------------------------------------| | value | None | The number of queries per second on the current FE (only counts query requests) | #### Metric Set: doris_fe_query_err_rate - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------ | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------------| | value | None | The number of erroneous queries per second | #### Metric Set: doris_fe_report_queue_size - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The length of the queue for various regular reporting tasks on the BE side at the FE end. This value reflects the degree of blocking of reporting tasks on the Master FE node. A larger value indicates insufficient processing capacity on the FE | #### Metric Set: doris_fe_rps - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ---------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|------------------------------------------------------------------------------------------------------| | value | None | The number of requests per second on the current FE (includes queries and other types of statements) | #### Metric Set: doris_fe_scheduled_tablet_num - -| Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | value | None | The number of tablets currently being scheduled by the Master FE node. This includes tablets that are being repaired and tablets that are being balanced. This value can reflect the number of tablets currently migrating in the cluster. If there is a value for a long time, it indicates that the cluster is unstable | #### Metric Set: doris_fe_txn_status Can observe the number of import transactions in various states to determine if there is a backlog. - | Metric Name | Metric Unit | Metric help description | -| ----------- | ----------- | ----------------------- | +|-------------|-------------|-------------------------| | unknown | None | Unknown state | | prepare | None | In preparation | | committed | None | Committed | | visible | None | Visible | | aborted | None | Aborted / Revoked | + diff --git a/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md b/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md index 7418e17cc1b..fd36206bc6e 100644 --- a/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md +++ b/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md @@ -24,6 +24,7 @@ management: exposure: include: '*' ``` + Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has response json data as follows: ```json @@ -60,7 +61,6 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo 3. Add DynamicTp monitoring under HertzBeat middleware monitoring - ### Configuration parameters | Parameter name | Parameter help description | @@ -78,24 +78,25 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo #### 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 | +| 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.5.x/help/elasticsearch.md b/home/versioned_docs/version-v1.5.x/help/elasticsearch.md index 25078850862..3ac3d62a7e1 100644 --- a/home/versioned_docs/version-v1.5.x/help/elasticsearch.md +++ b/home/versioned_docs/version-v1.5.x/help/elasticsearch.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -27,7 +27,7 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] #### Metrics Set：health -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-----------------------|-------------|-------------------------------------------| | cluster_name | none | Cluster Name | | status | none | status | @@ -49,7 +49,7 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] #### Metrics Set：nodes_detail -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------------|-------------|-------------------------| | node_name | none | Node Name | | ip | none | IP Address | @@ -61,3 +61,4 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] | disk_free | GB | Disk Free | | disk_total | GB | Disk Total | | disk_used_percent | % | Disk Used Percent | + diff --git a/home/versioned_docs/version-v1.5.x/help/euleros.md b/home/versioned_docs/version-v1.5.x/help/euleros.md index c63c6c26643..786dab30afc 100644 --- a/home/versioned_docs/version-v1.5.x/help/euleros.md +++ b/home/versioned_docs/version-v1.5.x/help/euleros.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitoring, ensuring uniqueness. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|---------------------------| | Host Name | None | Host name. | | System Version | None | Operating system version. | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|-------------------------------------------| | info | None | CPU model. | | cores | None | Number of CPU cores. | @@ -47,7 +47,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Memory Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|------------------------------------| | total | Mb | Total memory capacity. | | used | Mb | Used memory by user programs. | @@ -58,7 +58,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Disk Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------|-------------|------------------------------------| | disk_num | None | Total number of disks. | | partition_num | None | Total number of partitions. | @@ -68,7 +68,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Mo #### Metric Set: Interface Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------------| | interface_name | None | Name of the network interface. | | receive_bytes | Mb | Inbound data traffic. | @@ -105,3 +105,4 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/versioned_docs/version-v1.5.x/help/flink.md b/home/versioned_docs/version-v1.5.x/help/flink.md index 2115a1f0b0f..bd731a6dee6 100644 --- a/home/versioned_docs/version-v1.5.x/help/flink.md +++ b/home/versioned_docs/version-v1.5.x/help/flink.md @@ -7,10 +7,9 @@ keywords: [open source monitoring tool, open source flink monitoring tool] > Collect and monitor the general performance Metrics of Flink. - ### Configuration parameter -| Parameter Name | Parameter Help Description | +| Parameter Name | Parameter Help Description | |---------------------|-----------------------------------------------------------------------------------------------------------------------------| | Monitor Host | The monitored peer IPV4, IPV6, or domain name. Note: Do not include protocol headers (e.g., https://, http://). | | Task Name | Identifier for this monitoring task, name must be unique. | @@ -27,13 +26,11 @@ keywords: [open source monitoring tool, open source flink monitoring tool] #### Metrics Set：Overview -| Metric Name | Metric Unit | Metric Help Description | -|---------------|-------------|-------------------------| -| slots_total | Units | Total number of slots. | -| slots_used | Units | Number of slots used. | -| task_total | Units | Total number of tasks. | -| jobs_running | Units | Number of jobs running. | -| jobs_failed | Units | Number of jobs failed. | - - +| Metric Name | Metric Unit | Metric Help Description | +|--------------|-------------|-------------------------| +| slots_total | Units | Total number of slots. | +| slots_used | Units | Number of slots used. | +| task_total | Units | Total number of tasks. | +| jobs_running | Units | Number of jobs running. | +| jobs_failed | Units | Number of jobs failed. | diff --git a/home/versioned_docs/version-v1.5.x/help/freebsd.md b/home/versioned_docs/version-v1.5.x/help/freebsd.md index 96d9866743b..51d0ed9ab0b 100644 --- a/home/versioned_docs/version-v1.5.x/help/freebsd.md +++ b/home/versioned_docs/version-v1.5.x/help/freebsd.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source Operating System Monitori ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | | Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source Operating System Monitori #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------| | Host Name | None | Host name | | System Version | None | Operating system version | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source Operating System Monitori #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|----------------------------------------------| | info | None | CPU model | | cores | Number | Number of CPU cores | @@ -85,3 +85,4 @@ Statistics of the top 10 processes using memory. Statistics include: Process ID, | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/versioned_docs/version-v1.5.x/help/ftp.md b/home/versioned_docs/version-v1.5.x/help/ftp.md index 8802d3ab415..50a571eb7a7 100644 --- a/home/versioned_docs/version-v1.5.x/help/ftp.md +++ b/home/versioned_docs/version-v1.5.x/help/ftp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source ftp server monitoring tool, ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: ftp://). | | Monitoring name | Identify the name of this monitoring, The name needs to be unique. | @@ -28,7 +28,8 @@ keywords: [ open source monitoring tool, open source ftp server monitoring tool, #### Metrics Set：Basic -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |---------------|-------------|----------------------------------------------------------| | Is Active | none | Check if the directory exists and has access permission. | | Response Time | ms | Response Time | + diff --git a/home/versioned_docs/version-v1.5.x/help/fullsite.md b/home/versioned_docs/version-v1.5.x/help/fullsite.md index 3246fa31d82..6145f238bdc 100644 --- a/home/versioned_docs/version-v1.5.x/help/fullsite.md +++ b/home/versioned_docs/version-v1.5.x/help/fullsite.md @@ -7,28 +7,29 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon > 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. +> Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. -### Configuration parameter +### 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 | +| 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 +### Collection Metric -#### Metric set：summary +#### 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 | -| 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.5.x/help/guide.md b/home/versioned_docs/version-v1.5.x/help/guide.md index 1d9bac72dd5..ce182746ffa 100644 --- a/home/versioned_docs/version-v1.5.x/help/guide.md +++ b/home/versioned_docs/version-v1.5.x/help/guide.md @@ -5,19 +5,19 @@ sidebar_label: Help Center --- > Hertzbeat - An open source, real-time monitoring tool with custom-monitor and agentLess. -> Help documents and auxiliary information during use +> 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 +### Application service monitoring - 👉 [Website monitoring](website)
- 👉 [HTTP API](api)
- 👉 [PING Connectivity](ping)
- 👉 [Port availability](port)
+ 👉 [Website monitoring](website)
+ 👉 [HTTP API](api)
+ 👉 [PING Connectivity](ping)
+ 👉 [Port availability](port)
 👉 [Full site monitoring](fullsite)
 👉 [SSL Cert monitoring](ssl_cert)
 👉 [DNS monitoring](dns)
@@ -32,7 +32,7 @@ sidebar_label: Help Center  👉 [SpringBoot3.0](springboot3)
 👉 [DynamicTp](dynamic_tp)
-### Database monitoring +### Database monitoring  👉 [MYSQL database monitoring](mysql)
 👉 [MariaDB database monitoring](mariadb)
@@ -51,8 +51,7 @@ sidebar_label: Help Center  👉 [Redis monitoring](redis)
 👉 [Memcached monitoring](memcached)
- -### Operating system monitoring +### Operating system monitoring  👉 [Linux operating system monitoring](linux)
 👉 [Windows operating system monitoring](windows)
@@ -92,35 +91,33 @@ sidebar_label: Help Center ### Network monitoring - 👉 [Huawei-switch](huawei_switch)
+ 👉 [Huawei-switch](huawei_switch)
### Server monitoring - *** -## 💡 Alarm service +## 💡 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 +### Alarm center > The triggered alarm information center provides query and filtering of alarm deletion, alarm processing, mark unprocessed, alarm level status, etc. -### Alarm configuration +### 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) +More details see 👉 [Threshold alarm](alert_threshold)
+   👉 [Threshold expression](alert_threshold_expr) -### Alarm notification +### 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. - +> 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)
@@ -134,4 +131,4 @@ More details see 👉 [Threshold alarm](alert_threshold)
### Plugins - 👉 [Plugin](plugin)
\ No newline at end of file + 👉 [Plugin](plugin)
diff --git a/home/versioned_docs/version-v1.5.x/help/hadoop.md b/home/versioned_docs/version-v1.5.x/help/hadoop.md index f0a458ecc9f..56f19472277 100644 --- a/home/versioned_docs/version-v1.5.x/help/hadoop.md +++ b/home/versioned_docs/version-v1.5.x/help/hadoop.md @@ -11,9 +11,10 @@ keywords: [Open Source Monitoring System, Open Source Java Monitoring, Hadoop JV ### 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. +> 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: @@ -31,12 +32,12 @@ export HADOOP_OPTS= "$HADOOP_OPTS -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. +- 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 | +| 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 | @@ -70,16 +71,15 @@ export HADOOP_OPTS= "$HADOOP_OPTS #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -88,4 +88,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.5.x/help/hbase_master.md b/home/versioned_docs/version-v1.5.x/help/hbase_master.md index 188ad146a5a..1e3efe84af7 100644 --- a/home/versioned_docs/version-v1.5.x/help/hbase_master.md +++ b/home/versioned_docs/version-v1.5.x/help/hbase_master.md @@ -4,6 +4,7 @@ title: Monitoring Hbase Master sidebar_label: HbaseMaster Monitoring keywords: [Open Source Monitoring System, Open Source Database Monitoring, HbaseMaster Monitoring] --- + > Collect monitoring data for general performance metrics of Hbase Master. **Protocol: HTTP** @@ -14,13 +15,12 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po ## Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note: without protocol header (e.g., https://, http://). | | Port | The port number of the Hbase master, default is 16010. That is, the value of the`hbase.master.info.port` parameter. | | Task Name | The name identifying this monitoring, which needs to be unique. | -| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | +| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | | Collection Interval | The periodic collection interval for monitoring data, in seconds, with the minimum allowable interval being 30 seconds. | | Probe | Whether to probe and check the availability of monitoring before adding new monitoring, and proceed with the addition or modification operation only if the probe is successful. | | Description | Additional notes and descriptions for this monitoring, users can add notes here. | @@ -29,9 +29,8 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po #### Metric Set: server - -| Metric Name | Unit | Metric Description | -| -------------------- | ---- | --------------------------------------- | +| Metric Name | Unit | Metric Description | +|----------------------|------|-----------------------------------------| | numRegionServers | none | Number of currently alive RegionServers | | numDeadRegionServers | none | Number of currently dead RegionServers | | averageLoad | none | Cluster average load | @@ -39,18 +38,16 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po #### Metric Set: Rit - -| Metric Name | Unit | Metric Description | -| -------------------- | ---- | -------------------------------- | +| Metric Name | Unit | Metric Description | +|----------------------|------|----------------------------------| | ritnone | none | Current number of RIT | | ritnoneOverThreshold | none | Number of RIT over the threshold | | ritOldestAge | ms | Duration of the oldest RIT | #### Metric Set: basic - -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | ------------------------------------------- | +| Metric Name | Unit | Metric Description | +|-------------------------|------|---------------------------------------------| | liveRegionServers | none | List of currently active RegionServers | | deadRegionServers | none | List of currently offline RegionServers | | zookeeperQuorum | none | Zookeeper list | @@ -60,3 +57,4 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po | receivedBytes | MB | Cluster received data volume | | sentBytes | MB | Cluster sent data volume (MB) | | clusterRequests | none | Total number of cluster requests | + diff --git a/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md b/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md index 4e676491022..0a77eb5441b 100644 --- a/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md +++ b/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md @@ -4,6 +4,7 @@ title: Monitoring HBase RegionServer Monitoring sidebar_label: HBase RegionServer Monitoring keywords: [Open-source monitoring system, Open-source database monitoring, RegionServer monitoring] --- + > Collect and monitor common performance metrics for HBase RegionServer. **Protocol:** HTTP @@ -14,13 +15,12 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. ## Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| Target Host | The IPV4, IPV6, or domain name of the monitored entity. Note ⚠️ Do not include the protocol header (e.g., https://, http://). | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | The IPV4, IPV6, or domain name of the monitored entity. Note ⚠️ Do not include the protocol header (e.g., https://, http://). | | Port | The port number of the HBase regionserver, default is 16030, i.e., the value of the`hbase.regionserver.info.port` parameter | | Task Name | A unique name to identify this monitoring task. | -| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | +| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | | Collection Interval | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | | Probe Before Adding | Whether to probe and check the availability of monitoring before adding new monitoring, only proceed with the addition if the probe is successful. | | Description Note | Additional notes to identify and describe this monitoring, users can add notes here. | @@ -31,9 +31,8 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. #### Metric Set: server - -| Metric Name | Unit | Metric Description | -| --------------------------------- | ----- | ------------------------------------------------------------------------- | +| Metric Name | Unit | Metric Description | +|-----------------------------------|-------|---------------------------------------------------------------------------| | regionCount | None | Number of Regions | | readRequestCount | None | Number of read requests since cluster restart | | writeRequestCount | None | Number of write requests since cluster restart | @@ -74,9 +73,8 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. #### Metric Set: IPC - -| Metric Name | Unit | Metric Description | -| ------------------------- | ---- | -------------------------------------- | +| Metric Name | Unit | Metric Description | +|---------------------------|------|----------------------------------------| | numActiveHandler | None | Current number of RITs | | NotServingRegionException | None | Number of RITs exceeding the threshold | | RegionMovedException | ms | Duration of the oldest RIT | @@ -84,9 +82,8 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. #### Metric Set: JVM - -| Metric Name | Unit | Metric Description | -| -------------------- | ---- | --------------------------------- | +| Metric Name | Unit | Metric Description | +|----------------------|------|-----------------------------------| | MemNonHeapUsedM | None | Current active RegionServer list | | MemNonHeapCommittedM | None | Current offline RegionServer list | | MemHeapUsedM | None | Zookeeper list | @@ -94,3 +91,4 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. | MemHeapMaxM | None | Cluster balance load times | | MemMaxM | None | RPC handle count | | GcCount | MB | Cluster data reception volume | + diff --git a/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md b/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md index 2e09fb9fba1..164adc7d6df 100644 --- a/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md +++ b/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md @@ -15,42 +15,43 @@ Retrieve the HTTP monitoring port for the Apache HDFS DataNode. Value: `dfs.data ## Configuration Parameters -| Parameter Name | Parameter Description | -| ----------------- |-------------------------------------------------------| -| Target Host | IP(v4 or v6) or domain name of the target to be monitored. Exclude protocol. | -| Port | Monitoring port number for Apache HDFS DataNode, default is 50075. | -| Query Timeout | Timeout for querying Apache HDFS DataNode, in milliseconds, default is 6000 milliseconds. | +| Parameter Name | Parameter Description | +|-----------------------------|-------------------------------------------------------------------------------------------| +| Target Host | IP(v4 or v6) or domain name of the target to be monitored. Exclude protocol. | +| Port | Monitoring port number for Apache HDFS DataNode, default is 50075. | +| Query Timeout | Timeout for querying Apache HDFS DataNode, in milliseconds, default is 6000 milliseconds. | | Metrics Collection Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. | -| Probe Before Monitoring | Whether to probe and check monitoring availability before adding. | -| Description/Remarks | Additional description and remarks for this monitoring. | +| Probe Before Monitoring | Whether to probe and check monitoring availability before adding. | +| Description/Remarks | Additional description and remarks for this monitoring. | ### Metrics Collected #### Metric Set: FSDatasetState -| Metric Name | Metric Unit | Metric Description | -| ------------ | ----------- | ------------------------------ | -| DfsUsed | GB | DataNode HDFS usage | -| Remaining | GB | Remaining space on DataNode HDFS | -| Capacity | GB | Total capacity of DataNode HDFS | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|----------------------------------| +| DfsUsed | GB | DataNode HDFS usage | +| Remaining | GB | Remaining space on DataNode HDFS | +| Capacity | GB | Total capacity of DataNode HDFS | #### Metric Set: JvmMetrics -| Metric Name | Metric Unit | Metric Description | -| ---------------------- | ----------- | ----------------------------------------- | -| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | -| MemNonHeapCommittedM | MB | Committed size of NonHeapMemory configured in JVM | -| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | -| MemHeapCommittedM | MB | Committed size of HeapMemory by JVM | -| MemHeapMaxM | MB | Maximum size of HeapMemory configured in JVM | -| MemMaxM | MB | Maximum memory available for JVM at runtime | -| ThreadsRunnable | Count | Number of threads in RUNNABLE state | -| ThreadsBlocked | Count | Number of threads in BLOCKED state | -| ThreadsWaiting | Count | Number of threads in WAITING state | -| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | +| Metric Name | Metric Unit | Metric Description | +|----------------------|-------------|---------------------------------------------------| +| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | +| MemNonHeapCommittedM | MB | Committed size of NonHeapMemory configured in JVM | +| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | +| MemHeapCommittedM | MB | Committed size of HeapMemory by JVM | +| MemHeapMaxM | MB | Maximum size of HeapMemory configured in JVM | +| MemMaxM | MB | Maximum memory available for JVM at runtime | +| ThreadsRunnable | Count | Number of threads in RUNNABLE state | +| ThreadsBlocked | Count | Number of threads in BLOCKED state | +| ThreadsWaiting | Count | Number of threads in WAITING state | +| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | #### Metric Set: runtime -| Metric Name | Metric Unit | Metric Description | -| ------------ | ----------- | ------------------ | -| StartTime | | Startup time | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|--------------------| +| StartTime | | Startup time | + diff --git a/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md b/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md index 1afd6d4b1ae..978daac3613 100644 --- a/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md +++ b/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md @@ -15,78 +15,79 @@ Ensure that you have obtained the JMX monitoring port for the HDFS NameNode. ## Configuration Parameters -| Parameter Name | Parameter Description | -| ------------------ |--------------------------------------------------------| -| Target Host | The IPv4, IPv6, or domain name of the target being monitored. Exclude protocol headers. | -| Port | The monitoring port number of the HDFS NameNode, default is 50070. | -| Query Timeout | Timeout for querying the HDFS NameNode, in milliseconds, default is 6000 milliseconds. | +| Parameter Name | Parameter Description | +|-----------------------------|-------------------------------------------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the target being monitored. Exclude protocol headers. | +| Port | The monitoring port number of the HDFS NameNode, default is 50070. | +| Query Timeout | Timeout for querying the HDFS NameNode, in milliseconds, default is 6000 milliseconds. | | Metrics Collection Interval | Time interval for collecting monitoring data, in seconds, minimum interval is 30 seconds. | -| Probe Before Monitoring | Whether to probe and check the availability of monitoring before adding it. | -| Description/Remarks | Additional description and remarks for this monitoring. | +| Probe Before Monitoring | Whether to probe and check the availability of monitoring before adding it. | +| Description/Remarks | Additional description and remarks for this monitoring. | ### Collected Metrics #### Metric Set: FSNamesystem -| Metric Name | Metric Unit | Metric Description | -| --------------------------- | ----------- | ------------------------------------- | -| CapacityTotal | | Total cluster storage capacity | -| CapacityTotalGB | GB | Total cluster storage capacity | -| CapacityUsed | | Used cluster storage capacity | -| CapacityUsedGB | GB | Used cluster storage capacity | -| CapacityRemaining | | Remaining cluster storage capacity | -| CapacityRemainingGB | GB | Remaining cluster storage capacity | -| CapacityUsedNonDFS | | Non-HDFS usage of cluster capacity | -| TotalLoad | | Total client connections in the cluster | -| FilesTotal | | Total number of files in the cluster | -| BlocksTotal | | Total number of BLOCKs | -| PendingReplicationBlocks | | Number of blocks awaiting replication | -| UnderReplicatedBlocks | | Number of blocks with insufficient replicas | -| CorruptBlocks | | Number of corrupt blocks | -| ScheduledReplicationBlocks | | Number of blocks scheduled for replication | -| PendingDeletionBlocks | | Number of blocks awaiting deletion | -| ExcessBlocks | | Number of excess blocks | -| PostponedMisreplicatedBlocks| | Number of misreplicated blocks postponed for processing | -| NumLiveDataNodes | | Number of live data nodes in the cluster | -| NumDeadDataNodes | | Number of data nodes marked as dead | -| NumDecomLiveDataNodes | | Number of decommissioned live nodes | -| NumDecomDeadDataNodes | | Number of decommissioned dead nodes | -| NumDecommissioningDataNodes | | Number of nodes currently being decommissioned | -| TransactionsSinceLastCheckpoint | | Number of transactions since the last checkpoint | -| LastCheckpointTime | | Time of the last checkpoint | -| PendingDataNodeMessageCount| | Number of DATANODE requests queued in the standby namenode | +| Metric Name | Metric Unit | Metric Description | +|---------------------------------|-------------|------------------------------------------------------------| +| CapacityTotal | | Total cluster storage capacity | +| CapacityTotalGB | GB | Total cluster storage capacity | +| CapacityUsed | | Used cluster storage capacity | +| CapacityUsedGB | GB | Used cluster storage capacity | +| CapacityRemaining | | Remaining cluster storage capacity | +| CapacityRemainingGB | GB | Remaining cluster storage capacity | +| CapacityUsedNonDFS | | Non-HDFS usage of cluster capacity | +| TotalLoad | | Total client connections in the cluster | +| FilesTotal | | Total number of files in the cluster | +| BlocksTotal | | Total number of BLOCKs | +| PendingReplicationBlocks | | Number of blocks awaiting replication | +| UnderReplicatedBlocks | | Number of blocks with insufficient replicas | +| CorruptBlocks | | Number of corrupt blocks | +| ScheduledReplicationBlocks | | Number of blocks scheduled for replication | +| PendingDeletionBlocks | | Number of blocks awaiting deletion | +| ExcessBlocks | | Number of excess blocks | +| PostponedMisreplicatedBlocks | | Number of misreplicated blocks postponed for processing | +| NumLiveDataNodes | | Number of live data nodes in the cluster | +| NumDeadDataNodes | | Number of data nodes marked as dead | +| NumDecomLiveDataNodes | | Number of decommissioned live nodes | +| NumDecomDeadDataNodes | | Number of decommissioned dead nodes | +| NumDecommissioningDataNodes | | Number of nodes currently being decommissioned | +| TransactionsSinceLastCheckpoint | | Number of transactions since the last checkpoint | +| LastCheckpointTime | | Time of the last checkpoint | +| PendingDataNodeMessageCount | | Number of DATANODE requests queued in the standby namenode | #### Metric Set: RPC -| Metric Name | Metric Unit | Metric Description | -| ------------------------- | ----------- | -------------------------- | -| ReceivedBytes | | Data receiving rate | -| SentBytes | | Data sending rate | -| RpcQueueTimeNumOps | | RPC call rate | +| Metric Name | Metric Unit | Metric Description | +|--------------------|-------------|---------------------| +| ReceivedBytes | | Data receiving rate | +| SentBytes | | Data sending rate | +| RpcQueueTimeNumOps | | RPC call rate | #### Metric Set: runtime -| Metric Name | Metric Unit | Metric Description | -| ------------------------- | ----------- | ------------------- | -| StartTime | | Start time | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|--------------------| +| StartTime | | Start time | #### Metric Set: JvmMetrics -| Metric Name | Metric Unit | Metric Description | -| ------------------------- | ----------- | ------------------- | -| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | -| MemNonHeapCommittedM | MB | Committed NonHeapMemory by JVM | -| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | -| MemHeapCommittedM | MB | Committed HeapMemory by JVM | -| MemHeapMaxM | MB | Maximum HeapMemory configured for JVM | -| MemMaxM | MB | Maximum memory that can be used by JVM | -| GcCountParNew | Count | Number of ParNew GC events | -| GcTimeMillisParNew | Milliseconds| Time spent in ParNew GC | -| GcCountConcurrentMarkSweep| Count | Number of ConcurrentMarkSweep GC events| -| GcTimeMillisConcurrentMarkSweep | Milliseconds | Time spent in ConcurrentMarkSweep GC | -| GcCount | Count | Total number of GC events | -| GcTimeMillis | Milliseconds| Total time spent in GC events | -| ThreadsRunnable | Count | Number of threads in RUNNABLE state | -| ThreadsBlocked | Count | Number of threads in BLOCKED state | -| ThreadsWaiting | Count | Number of threads in WAITING state | -| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state| +| Metric Name | Metric Unit | Metric Description | +|---------------------------------|--------------|------------------------------------------| +| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | +| MemNonHeapCommittedM | MB | Committed NonHeapMemory by JVM | +| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | +| MemHeapCommittedM | MB | Committed HeapMemory by JVM | +| MemHeapMaxM | MB | Maximum HeapMemory configured for JVM | +| MemMaxM | MB | Maximum memory that can be used by JVM | +| GcCountParNew | Count | Number of ParNew GC events | +| GcTimeMillisParNew | Milliseconds | Time spent in ParNew GC | +| GcCountConcurrentMarkSweep | Count | Number of ConcurrentMarkSweep GC events | +| GcTimeMillisConcurrentMarkSweep | Milliseconds | Time spent in ConcurrentMarkSweep GC | +| GcCount | Count | Total number of GC events | +| GcTimeMillis | Milliseconds | Total time spent in GC events | +| ThreadsRunnable | Count | Number of threads in RUNNABLE state | +| ThreadsBlocked | Count | Number of threads in BLOCKED state | +| ThreadsWaiting | Count | Number of threads in WAITING state | +| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | + diff --git a/home/versioned_docs/version-v1.5.x/help/hive.md b/home/versioned_docs/version-v1.5.x/help/hive.md index ec0d7dee398..806969c2e7c 100644 --- a/home/versioned_docs/version-v1.5.x/help/hive.md +++ b/home/versioned_docs/version-v1.5.x/help/hive.md @@ -16,6 +16,7 @@ If you want to monitor information in `Apache Hive` with this monitoring type, y ```shell hive --service metastore & ``` + **2. Enable hive server2:** ```shell @@ -24,55 +25,53 @@ 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 | +| 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 | +| 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 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 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 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. | +| 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. | - - +| used | MB | The amount of memory currently being used by the memory pool. | diff --git a/home/versioned_docs/version-v1.5.x/help/http_sd.md b/home/versioned_docs/version-v1.5.x/help/http_sd.md index 3278936d66d..6b8de487555 100644 --- a/home/versioned_docs/version-v1.5.x/help/http_sd.md +++ b/home/versioned_docs/version-v1.5.x/help/http_sd.md @@ -16,39 +16,37 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito > We currently support for `Consul` and `Nacos`. 2. Add http_sd monitor and enter necessary info about **Register center** on Hertzbeat, such as host, port and so on. - 3. Click **OK** # Configuration parameter -| Parameter name | Parameter help description | -| --------------------- | ------------------------------------------------------------ | -| Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Task name | Identify the name of this monitoring. The name needs to be unique | -| Port | Port provided by Register center | -| Discovery Client Type | Select one Register center that you want to monitor | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Parameter name | Parameter help description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by Register center | +| Discovery Client Type | Select one Register center that you want to monitor | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | # Collection Metrics ## Metrics Set：server -| Metric name | Metric unit | Metric help description | -| ------------- | ----------- | ----------------------- | +| Metric name | Metric unit | Metric help description | +|---------------|-------------|-------------------------| | Address | | | | Port | | | | Response Time | ms | | ## Metrics Set：service -| Metric name | Metric unit | Metric help description | -| ------------- | ----------- | -------------------------------- | +| Metric name | Metric unit | Metric help description | +|---------------|-------------|----------------------------------| | Service Id | | | | Service Name | | | | Address | | | | Port | | | | Health Status | | Current health status of service | - diff --git a/home/versioned_docs/version-v1.5.x/help/huawei_switch.md b/home/versioned_docs/version-v1.5.x/help/huawei_switch.md index 2e9982c5ef9..902c0596965 100644 --- a/home/versioned_docs/version-v1.5.x/help/huawei_switch.md +++ b/home/versioned_docs/version-v1.5.x/help/huawei_switch.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, network monitoring, Huawei switch ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | | Task Name | Identify the name of this monitoring. The name needs to be unique | @@ -25,8 +25,8 @@ keywords: [ open source monitoring tool, network monitoring, Huawei switch ] | SNMP privPassphrase | For SNMP v3, SNMP encrypted passwords | | privPassword Encryption | For SNMP v3, SNMP encrypted algorithm | | Timeout | Set the timeout time when querying unresponsive data, in milliseconds, the default is 6000 milliseconds | -| Intervals | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Description | For more information about identifying and describing this monitoring, users can note information here | +| Intervals | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Description | For more information about identifying and describing this monitoring, users can note information here | ### Collection Metric @@ -37,7 +37,7 @@ This document only introduces the monitoring indicators queried in the monitor t #### Metric set: huawei_core -| Metric Name | Metric Unit | Metric Help Description | +| Metric Name | Metric Unit | Metric Help Description | |---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ifIndex | none | Interface index. This value is greater than zero and globally unique. | | ifDescr | none | A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the interface hardware/software. | @@ -47,7 +47,8 @@ This document only introduces the monitoring indicators queried in the monitor t | ifInDiscards | none | The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | | ifInErrors | none | For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | | ifOutOctets | octets | The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | -| ifOutDiscards | none | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutDiscards | none | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | | ifOutErrors | none | For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | | ifAdminStatus | none | The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state). | | ifOperStatus | none | The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If ifAdminStatus is down(2) then ifOperStatus should be down(2). If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components. | + diff --git a/home/versioned_docs/version-v1.5.x/help/hugegraph.md b/home/versioned_docs/version-v1.5.x/help/hugegraph.md index 4fca13f4e00..66b0574aab7 100644 --- a/home/versioned_docs/version-v1.5.x/help/hugegraph.md +++ b/home/versioned_docs/version-v1.5.x/help/hugegraph.md @@ -4,6 +4,7 @@ title: Monitoring HugeGraph Monitoring sidebar_label: Apache HugeGraph keywords: [Open Source Monitoring System, Open Source Database Monitoring, HugeGraph Monitoring] --- + > Collect and monitor the general performance metrics of HugeGraph **Protocol used: HTTP** @@ -14,137 +15,127 @@ Check the `rest-server.properties` file to obtain the value of the `restserver_p ## Configuration Parameters - -| Parameter Name | Parameter Description | -|------------------|--------------------------------------------------------| -| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). | -| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter | -| Enable SSL | Enable SSL usage | -| Base Path | Base path, default is: /metrics, usually does not need to be modified | -| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | -| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds | -| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful | -| Description | Additional identification and description of this monitoring, users can add information here | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). | +| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter | +| Enable SSL | Enable SSL usage | +| Base Path | Base path, default is: /metrics, usually does not need to be modified | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds | +| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful | +| Description | Additional identification and description of this monitoring, users can add information here | ### Metrics Collection #### Metric Set: gauges -| Metric Name | Metric Unit | Metric Description | -| ------------------------------------ | -------- | --------------------------------- | -| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph | -| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data | -| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache | -| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache | -| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph | -| instances | NONE | Indicates the number of currently running HugeGraph instances| -| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph | -| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data | -| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache| -| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache| -| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph | -| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph | -| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data | -| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache| -| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache| -| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph | -| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph | -| token-hugegraph-expire | NONE | Indicates the expiration time of token data | -| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache | -| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache | -| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph | -| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph | -| users-hugegraph-expire | NONE | Indicates the expiration time of user data | -| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache | -| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache | -| users-hugegraph-size | NONE | Indicates the number of users in the current graph | -| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords | -| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data | -| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache| -| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache| -| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph | -| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph | -| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data | -| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache | -| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache | -| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph | -| batch-write-threads | NONE | Indicates the number of threads for batch write operations | -| max-write-threads | NONE | Indicates the maximum number of threads for write operations | -| pending-tasks | NONE | Indicates the number of pending tasks | -| workers | NONE | Indicates the current number of worker threads | -| average-load-penalty | NONE | Indicates the average load penalty | -| estimated-size | NONE | Indicates the estimated data size | -| eviction-count | NONE | Indicates the number of evicted data entries | -| eviction-weight | NONE | Indicates the weight of evicted data | -| hit-count | NONE | Indicates the total cache hits | -| hit-rate | NONE | Indicates the cache hit rate | -| load-count | NONE | Indicates the number of data loads | -| load-failure-count | NONE | Indicates the number of data load failures | -| load-failure-rate | NONE | Indicates the data load failure rate | -| load-success-count | NONE | Indicates the number of successful data loads | -| long-run-compilation-count | NONE | Indicates the number of long-running compilations | -| miss-count | NONE | Indicates the total cache misses | -| miss-rate | NONE | Indicates the cache miss rate | -| request-count | NONE | Indicates the total request count | -| total-load-time | NONE | Indicates the total data load time | -| sessions | NONE | Indicates the current number of active sessions | - - - +| Metric Name | Metric Unit | Metric Description | +|--------------------------------|-------------|----------------------------------------------------------------| +| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph | +| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data | +| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache | +| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache | +| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph | +| instances | NONE | Indicates the number of currently running HugeGraph instances | +| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph | +| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data | +| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache | +| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache | +| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph | +| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph | +| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data | +| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache | +| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache | +| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph | +| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph | +| token-hugegraph-expire | NONE | Indicates the expiration time of token data | +| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache | +| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache | +| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph | +| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph | +| users-hugegraph-expire | NONE | Indicates the expiration time of user data | +| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache | +| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache | +| users-hugegraph-size | NONE | Indicates the number of users in the current graph | +| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords | +| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data | +| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache | +| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache | +| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph | +| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph | +| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data | +| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache | +| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache | +| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph | +| batch-write-threads | NONE | Indicates the number of threads for batch write operations | +| max-write-threads | NONE | Indicates the maximum number of threads for write operations | +| pending-tasks | NONE | Indicates the number of pending tasks | +| workers | NONE | Indicates the current number of worker threads | +| average-load-penalty | NONE | Indicates the average load penalty | +| estimated-size | NONE | Indicates the estimated data size | +| eviction-count | NONE | Indicates the number of evicted data entries | +| eviction-weight | NONE | Indicates the weight of evicted data | +| hit-count | NONE | Indicates the total cache hits | +| hit-rate | NONE | Indicates the cache hit rate | +| load-count | NONE | Indicates the number of data loads | +| load-failure-count | NONE | Indicates the number of data load failures | +| load-failure-rate | NONE | Indicates the data load failure rate | +| load-success-count | NONE | Indicates the number of successful data loads | +| long-run-compilation-count | NONE | Indicates the number of long-running compilations | +| miss-count | NONE | Indicates the total cache misses | +| miss-rate | NONE | Indicates the cache miss rate | +| request-count | NONE | Indicates the total request count | +| total-load-time | NONE | Indicates the total data load time | +| sessions | NONE | Indicates the current number of active sessions | #### Metric Set: counters - - -| Metric Name | Metric Unit | Metric Description | -| --------------------------------------------- | -------- | ---------------------------------------- | -| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests | -| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests | -| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico | -| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico | -| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources | -| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources | -| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources | -| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs | -| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs | -| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics | -| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | -| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics | -| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | -| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges | -| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges | - - - +| Metric Name | Metric Unit | Metric Description | +|-----------------------------------------------------|-------------|--------------------------------------------------------------------------------| +| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests | +| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests | +| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico | +| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico | +| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources | +| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources | +| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources | +| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs | +| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs | +| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics | +| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | +| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics | +| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | +| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges | +| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges | #### Metric Set: system +| Metric Name | Metric Unit | Metric Description | +|---------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------| +| mem | NONE | Indicates the total memory of the system | +| mem_total | NONE | Indicates the total memory of the system (same as mem) | +| mem_used | NONE | Indicates the currently used memory of the system | +| mem_free | NONE | Indicates the free memory of the system | +| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) | +| processors | NONE | Indicates the number of processors in the system | +| uptime | NONE | Indicates the system uptime, i.e., the time since booting | +| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness | +| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM | +| heap_init | NONE | Indicates the initial size of JVM heap memory | +| heap_used | NONE | Indicates the currently used JVM heap memory size | +| heap_max | NONE | Indicates the maximum available size of JVM heap memory | +| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory | +| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory | +| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size | +| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory | +| thread_peak | NONE | Indicates the peak number of threads since JVM startup | +| thread_daemon | NONE | Indicates the current number of active daemon threads | +| thread_total_started | NONE | Indicates the total number of threads started since JVM startup | +| thread_count | NONE | Indicates the current number of active threads | +| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector | +| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector | +| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector | +| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector | +| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) | - -| Metric Name | Metric Unit | Metric Description | -| --------------------------------------------- | -------- | -------------------------------------------------- | -| mem | NONE | Indicates the total memory of the system | -| mem_total | NONE | Indicates the total memory of the system (same as mem) | -| mem_used | NONE | Indicates the currently used memory of the system | -| mem_free | NONE | Indicates the free memory of the system | -| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) | -| processors | NONE | Indicates the number of processors in the system | -| uptime | NONE | Indicates the system uptime, i.e., the time since booting | -| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness | -| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM | -| heap_init | NONE | Indicates the initial size of JVM heap memory | -| heap_used | NONE | Indicates the currently used JVM heap memory size | -| heap_max | NONE | Indicates the maximum available size of JVM heap memory | -| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory | -| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory | -| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size | -| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory | -| thread_peak | NONE | Indicates the peak number of threads since JVM startup | -| thread_daemon | NONE | Indicates the current number of active daemon threads | -| thread_total_started | NONE | Indicates the total number of threads started since JVM startup | -| thread_count | NONE | Indicates the current number of active threads | -| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector | -| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector | -| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector | -| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector | -| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) | \ No newline at end of file diff --git a/home/versioned_docs/version-v1.5.x/help/influxdb.md b/home/versioned_docs/version-v1.5.x/help/influxdb.md index cf3d838e796..92c5da380ef 100644 --- a/home/versioned_docs/version-v1.5.x/help/influxdb.md +++ b/home/versioned_docs/version-v1.5.x/help/influxdb.md @@ -7,61 +7,60 @@ keywords: [open source monitoring system, open source database monitoring, Influ ### Configuration Parameters -| Parameter Name | Parameter Description | -| -------------- | -------------------------------------------------------- | -| Monitor Host | The IPv4, IPv6, or domain name of the target being monitored. Note⚠️: Do not include the protocol header (e.g., https://, http://). | -| Task Name | A unique identifier for this monitoring task. | -| Port | The port on which the database is exposed. Default is 8086. | -| URL | The database connection URL, usually constructed from the host. No need to add it separately. | -| Collection Interval | The interval at which data is collected during monitoring, in seconds. The minimum interval that can be set is 30 seconds. | -| Probe Enabled | Whether to perform a probe check for monitoring availability before adding or modifying the monitoring task. | -| Description | Additional notes and remarks about this monitoring task. Users can provide information and descriptions here. | +| Parameter Name | Parameter Description | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | The IPv4, IPv6, or domain name of the target being monitored. Note⚠️: Do not include the protocol header (e.g., https://, http://). | +| Task Name | A unique identifier for this monitoring task. | +| Port | The port on which the database is exposed. Default is 8086. | +| URL | The database connection URL, usually constructed from the host. No need to add it separately. | +| Collection Interval | The interval at which data is collected during monitoring, in seconds. The minimum interval that can be set is 30 seconds. | +| Probe Enabled | Whether to perform a probe check for monitoring availability before adding or modifying the monitoring task. | +| Description | Additional notes and remarks about this monitoring task. Users can provide information and descriptions here. | ### Collected Metrics #### Metric Set: influxdb_info | Metric Name | Metric Unit | Metric Description | -|------------| ----------- |--------| -| build_date | N/A | Creation date | -| os | N/A | Operating system | -| cpus | N/A | CPUs | -| version | N/A | Version number | +|-------------|-------------|--------------------| +| build_date | N/A | Creation date | +| os | N/A | Operating system | +| cpus | N/A | CPUs | +| version | N/A | Version number | #### Metric Set: http_api_request_duration_seconds -| Metric Name | Metric Unit | Metric Description | -|---------------|------|---------| -| handler | N/A | Handler | -| path | N/A | Path | -| response_code | N/A | Response code | -| method | N/A | Request method | -| user_agent | N/A | User agent | -| status | N/A | Status | +| Metric Name | Metric Unit | Metric Description | +|---------------|-------------|--------------------| +| handler | N/A | Handler | +| path | N/A | Path | +| response_code | N/A | Response code | +| method | N/A | Request method | +| user_agent | N/A | User agent | +| status | N/A | Status | #### Metric Set: storage_compactions_queued -| Metric Name | Metric Unit | Metric Description | -|---------------------------------|------|------------| -| bucket | N/A | Storage bucket | -| engine | N/A | Engine type | -| id | N/A | Identifier | -| level | N/A | Level | -| path | N/A | Data file path | - +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|--------------------| +| bucket | N/A | Storage bucket | +| engine | N/A | Engine type | +| id | N/A | Identifier | +| level | N/A | Level | +| path | N/A | Data file path | #### Metric Set: http_write_request_bytes -| Metric Name | Metric Unit | Metric Description | -| ----------- |------|--------| -| endpoint | N/A | Endpoint | -| org_id | N/A | Organization identifier | -| status | N/A | Status | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|-------------------------| +| endpoint | N/A | Endpoint | +| org_id | N/A | Organization identifier | +| status | N/A | Status | #### Metric Set: qc_requests_total -| Metric Name | Metric Unit | Metric Description | -| ----------- |------|--------| -| result | N/A | Result | -| org | N/A | Organization identifier | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|-------------------------| +| result | N/A | Result | +| org | N/A | Organization identifier | diff --git a/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md b/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md index fcef4b4acff..afed14cad7a 100644 --- a/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md +++ b/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). | | Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: basic_influxdb_memstats_alloc -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: influxdb_database_numMeasurements -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | job | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -46,7 +46,7 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: influxdb_query_rate_seconds -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | @@ -54,8 +54,9 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL #### Metric Set: influxdb_queryExecutor_queriesFinished_10s -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | | value | None | Metric value | + diff --git a/home/versioned_docs/version-v1.5.x/help/iotdb.md b/home/versioned_docs/version-v1.5.x/help/iotdb.md index 0e4dcad9912..bec827feb73 100644 --- a/home/versioned_docs/version-v1.5.x/help/iotdb.md +++ b/home/versioned_docs/version-v1.5.x/help/iotdb.md @@ -61,33 +61,33 @@ predefinedMetrics: #### 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 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 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 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 | +| 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 @@ -114,7 +114,8 @@ predefinedMetrics: #### Metric collection: thrift_connections -| Metric Name | Metric Unit | Metric Help Description | -|-------|------|-------------| -| name | None | name | -| connection | none | thrift current connection number | +| Metric Name | Metric Unit | Metric Help Description | +|-------------|-------------|----------------------------------| +| name | None | name | +| connection | none | thrift current connection number | + diff --git a/home/versioned_docs/version-v1.5.x/help/issue.md b/home/versioned_docs/version-v1.5.x/help/issue.md index c3dffd147be..a48e84cfd4e 100644 --- a/home/versioned_docs/version-v1.5.x/help/issue.md +++ b/home/versioned_docs/version-v1.5.x/help/issue.md @@ -1,49 +1,58 @@ --- id: issue title: Common issues -sidebar_label: Common issues +sidebar_label: Common issues --- -### Monitoring 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 +1. **Page feedback：monitor.host: Monitoring Host must be ipv4, ipv6 or domain name** -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) +> 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 hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。 + > The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened. > When you install HertzBeat via DockerDocker root is enabled by default. No such problem. -> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address - -### Docker Deployment common issues +### Docker Deployment common issues 1. **MYSQL, TDENGINE and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** -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. + 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 .....` +> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy，visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issues： + Please refer to the following points to troubleshoot issues： + > one：Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed. -> two：Check whether dependent service, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. -> > three：`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. +> 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** -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. +> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. ### Package Deployment common issues 1. **According to the process deploy，visit http://ip:1157/ no interface** Please refer to the following points to troubleshoot issues: + > one：Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed. > two：Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`. > three： Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. 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. +> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. + diff --git a/home/versioned_docs/version-v1.5.x/help/jetty.md b/home/versioned_docs/version-v1.5.x/help/jetty.md index 3e5230aa9d0..6e069553dba 100644 --- a/home/versioned_docs/version-v1.5.x/help/jetty.md +++ b/home/versioned_docs/version-v1.5.x/help/jetty.md @@ -23,6 +23,7 @@ keywords: [open source monitoring tool, open source jetty web server monitoring 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. @@ -50,7 +51,7 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -73,19 +74,17 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` | max | kb | max size | | used | kb | used size | - #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | diff --git a/home/versioned_docs/version-v1.5.x/help/jvm.md b/home/versioned_docs/version-v1.5.x/help/jvm.md index 95b1545fffc..3b47e0e7a8a 100644 --- a/home/versioned_docs/version-v1.5.x/help/jvm.md +++ b/home/versioned_docs/version-v1.5.x/help/jvm.md @@ -24,7 +24,7 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -58,16 +58,15 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -76,4 +75,3 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.5.x/help/kafka.md b/home/versioned_docs/version-v1.5.x/help/kafka.md index 067cabef0e9..f86913733b1 100644 --- a/home/versioned_docs/version-v1.5.x/help/kafka.md +++ b/home/versioned_docs/version-v1.5.x/help/kafka.md @@ -27,70 +27,64 @@ 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 | +| 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 | - +| 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 | +| 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 | - +| 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 | +| 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 | - - - +| 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.5.x/help/kafka_promql.md b/home/versioned_docs/version-v1.5.x/help/kafka_promql.md index e88f6eb0342..ea358d0de8d 100644 --- a/home/versioned_docs/version-v1.5.x/help/kafka_promql.md +++ b/home/versioned_docs/version-v1.5.x/help/kafka_promql.md @@ -16,7 +16,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka ### Configuration Parameters -| Parameter Name | Parameter Description | +| Parameter Name | Parameter Description | |---------------------|----------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). | | Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. | @@ -35,7 +35,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka #### Metric Set: kafka_brokers -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | \_\_name__ | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -44,7 +44,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka #### Metric Set: kafka_topic_partitions -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | \_\_name__ | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -53,7 +53,7 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka #### Metric Set: kafka_server_brokertopicmetrics_bytesinpersec -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|--------------------------------------| | \_\_name__ | None | Metric name | | instance | None | Instance to which the metric belongs | @@ -64,3 +64,4 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka 1. If Kafka is enabled with JMX monitoring, you can use [Kafka](kafka) Monitoring. 2. If Kafka cluster deploys kafka_exporter to expose monitoring metrics, you can refer to [Prometheus task](prometheus) to configure the Prometheus collection task to monitor kafka. + diff --git a/home/versioned_docs/version-v1.5.x/help/kubernetes.md b/home/versioned_docs/version-v1.5.x/help/kubernetes.md index 8e10896c6d1..45adda576fc 100644 --- a/home/versioned_docs/version-v1.5.x/help/kubernetes.md +++ b/home/versioned_docs/version-v1.5.x/help/kubernetes.md @@ -28,6 +28,7 @@ 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 @@ -36,59 +37,60 @@ 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 | +| 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 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 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 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 | +| 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.5.x/help/linux.md b/home/versioned_docs/version-v1.5.x/help/linux.md index 05e3405ff6e..6c22028114c 100644 --- a/home/versioned_docs/version-v1.5.x/help/linux.md +++ b/home/versioned_docs/version-v1.5.x/help/linux.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source linux monitoring tool, monit ### 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 | +| 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 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 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 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 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 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 | +| 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.5.x/help/mariadb.md b/home/versioned_docs/version-v1.5.x/help/mariadb.md index e72668fe791..374e6e6a081 100644 --- a/home/versioned_docs/version-v1.5.x/help/mariadb.md +++ b/home/versioned_docs/version-v1.5.x/help/mariadb.md @@ -9,49 +9,46 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - - +| 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.5.x/help/memcached.md b/home/versioned_docs/version-v1.5.x/help/memcached.md index 5d89ce0977b..920da021e6b 100644 --- a/home/versioned_docs/version-v1.5.x/help/memcached.md +++ b/home/versioned_docs/version-v1.5.x/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 You need to use the stats command to view the parameters that your memcache can monitor ``` -### +### **1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. @@ -36,7 +36,7 @@ STAT version 1.4.15 ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -49,7 +49,7 @@ STAT version 1.4.15 #### Metrics Set：server_info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|---------------------------------------------------| | pid | | Memcache server process ID | | uptime | s | The number of seconds the server has been running | @@ -66,4 +66,5 @@ STAT version 1.4.15 | cmd_set | | Set command request count | | cmd_flush | | Flush command request count | | get_misses | | Get command misses | -| delete_misses | | Delete command misses | \ No newline at end of file +| delete_misses | | Delete command misses | + diff --git a/home/versioned_docs/version-v1.5.x/help/mongodb.md b/home/versioned_docs/version-v1.5.x/help/mongodb.md index 4a2951ec23c..9c536e73d7a 100644 --- a/home/versioned_docs/version-v1.5.x/help/mongodb.md +++ b/home/versioned_docs/version-v1.5.x/help/mongodb.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |------------------------|-------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -27,7 +27,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:Build Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|-----------------------------------------------------------------------------------------| | version | none | The version number of the MongoDB server. | | gitVersion | none | The Git version of the MongoDB codebase. | @@ -39,7 +39,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:Server Document -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|-----------------------------------| | deleted | none | The number of documents deleted. | | inserted | none | The number of documents inserted. | @@ -48,21 +48,21 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:Server Operation -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |----------------|-------------|------------------------------------------------------------------| | scanAndOrder | none | The number of times a query required both scanning and ordering. | | writeConflicts | none | The number of write conflicts that occurred. | #### Metric set: Max Connections -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |------------------|-------------|--------------------------------------------| | deletedDocuments | none | Number of deleted documents. | | passes | none | Total number of passes for TTL operations. | #### Metric set:System Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|------------------------------------------------------| | currentTime | none | Current system time. | | hostname | none | Hostname of the server. | @@ -75,7 +75,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set:OS Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------|-------------|----------------------------------| | type | none | Type of the operating system. | | name | none | Name of the operating system. | @@ -83,7 +83,7 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m #### Metric set：Extra Info -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-----------------|-------------|--------------------------------------------------------| | versionString | none | String describing the version of the operating system. | | libcVersion | none | Version of the C standard library (libc). | diff --git a/home/versioned_docs/version-v1.5.x/help/mysql.md b/home/versioned_docs/version-v1.5.x/help/mysql.md index 3f07be99380..dca64b3f9f0 100644 --- a/home/versioned_docs/version-v1.5.x/help/mysql.md +++ b/home/versioned_docs/version-v1.5.x/help/mysql.md @@ -7,9 +7,9 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo > Collect and monitor the general performance Metrics of MySQL database. Support MYSQL5+. -### Configuration parameter +### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -27,31 +27,28 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo #### 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 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 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 | - - +| 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.5.x/help/nacos.md b/home/versioned_docs/version-v1.5.x/help/nacos.md index 721f1776c2a..4de3661c17b 100644 --- a/home/versioned_docs/version-v1.5.x/help/nacos.md +++ b/home/versioned_docs/version-v1.5.x/help/nacos.md @@ -13,81 +13,83 @@ keywords: [open source monitoring tool, open source middleware monitoring tool, 1. Deploy the Nacos cluster according to [deployment document](https://nacos.io/en-us/docs/deployment.html). 2. Configure the application. properties file to expose metrics data. + ``` management.endpoints.web.exposure.include=* ``` + 3. Access ```{ip}:8848/nacos/actuator/prometheus``` to see if metrics data can be accessed. More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-guide.html). -### Configuration parameter +### Configuration parameter -| Parameter name | Parameter help description | -|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Target name | Identify the name of this monitoring. The name needs to be unique | -| Nacos Port | Port provided by the Nacos Server. The default is 8848 | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | +| Parameter name | Parameter help description | +|---------------------|-------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Target name | Identify the name of this monitoring. The name needs to be unique | +| Nacos Port | Port provided by the Nacos Server. The default is 8848 | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | ### Collection Metric #### Metric set：jvm -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| system_cpu_usage | none | cpu usage | -| system_load_average_1m | none | load | -| jvm_memory_used_bytes | byte | jvm memory used | -| jvm_memory_max_bytes | byte | jvm max memory | -| jvm_gc_pause_seconds_count | none | gc count | -| jvm_gc_pause_seconds_sum | second | gc time | -| jvm_threads_daemon | none | jvm threads count | +| Metric name | Metric unit | Metric help description | +|----------------------------|-------------|-------------------------| +| system_cpu_usage | none | cpu usage | +| system_load_average_1m | none | load | +| jvm_memory_used_bytes | byte | jvm memory used | +| jvm_memory_max_bytes | byte | jvm max memory | +| jvm_gc_pause_seconds_count | none | gc count | +| jvm_gc_pause_seconds_sum | second | gc time | +| jvm_threads_daemon | none | jvm threads count | #### Metric set：Nacos -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| http_server_requests_seconds_count | second | http requests count | -| http_server_requests_seconds_sum | second | http requests time | -| nacos_timer_seconds_sum | second | Nacos config notify time | -| nacos_timer_seconds_count | none | Nacos config notify count | -| nacos_monitor{name='longPolling'} | none | Nacos config connection count | -| nacos_monitor{name='configCount'} | none | Nacos configuration file count | -| nacos_monitor{name='dumpTask'} | none | Nacos config dump task count | -| nacos_monitor{name='notifyTask'} | none | Nacos config notify task count | -| nacos_monitor{name='getConfig'} | none | Nacos config read configuration count | -| nacos_monitor{name='publish'} | none | Nacos config update configuration count | -| nacos_monitor{name='ipCount'} | none | Nacos naming ip count | -| nacos_monitor{name='domCount'} | none | Nacos naming domain count(1.x version) | -| nacos_monitor{name='serviceCount'} | none | Nacos naming domain count(2.x version) | -| nacos_monitor{name='failedPush'} | none | Nacos naming push fail count | -| nacos_monitor{name='avgPushCost'} | second | Nacos naming push cost time(average) | -| nacos_monitor{name='leaderStatus'} | none | Nacos naming if node is leader | -| nacos_monitor{name='maxPushCost'} | second | Nacos naming push cost time(max) | -| nacos_monitor{name='mysqlhealthCheck'} | none | Nacos naming mysql health check count | -| nacos_monitor{name='httpHealthCheck'} | none | Nacos naming http health check count | -| nacos_monitor{name='tcpHealthCheck'} | none | Nacos naming tcp health check count | +| Metric name | Metric unit | Metric help description | +|----------------------------------------|-------------|-----------------------------------------| +| http_server_requests_seconds_count | second | http requests count | +| http_server_requests_seconds_sum | second | http requests time | +| nacos_timer_seconds_sum | second | Nacos config notify time | +| nacos_timer_seconds_count | none | Nacos config notify count | +| nacos_monitor{name='longPolling'} | none | Nacos config connection count | +| nacos_monitor{name='configCount'} | none | Nacos configuration file count | +| nacos_monitor{name='dumpTask'} | none | Nacos config dump task count | +| nacos_monitor{name='notifyTask'} | none | Nacos config notify task count | +| nacos_monitor{name='getConfig'} | none | Nacos config read configuration count | +| nacos_monitor{name='publish'} | none | Nacos config update configuration count | +| nacos_monitor{name='ipCount'} | none | Nacos naming ip count | +| nacos_monitor{name='domCount'} | none | Nacos naming domain count(1.x version) | +| nacos_monitor{name='serviceCount'} | none | Nacos naming domain count(2.x version) | +| nacos_monitor{name='failedPush'} | none | Nacos naming push fail count | +| nacos_monitor{name='avgPushCost'} | second | Nacos naming push cost time(average) | +| nacos_monitor{name='leaderStatus'} | none | Nacos naming if node is leader | +| nacos_monitor{name='maxPushCost'} | second | Nacos naming push cost time(max) | +| nacos_monitor{name='mysqlhealthCheck'} | none | Nacos naming mysql health check count | +| nacos_monitor{name='httpHealthCheck'} | none | Nacos naming http health check count | +| nacos_monitor{name='tcpHealthCheck'} | none | Nacos naming tcp health check count | #### Metric set：Nacos exception -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| nacos_exception_total{name='db'} | none | database exception | -| nacos_exception_total{name='configNotify'} | none | Nacos config notify exception | -| nacos_exception_total{name='unhealth'} | none | Nacos config server health check exception | -| nacos_exception_total{name='disk'} | none | Nacos naming write disk exception | -| nacos_exception_total{name='leaderSendBeatFailed'} | none | Nacos naming leader send heart beat fail count | -| nacos_exception_total{name='illegalArgument'} | none | request argument illegal count | -| nacos_exception_total{name='nacos'} | none | Nacos inner exception | +| Metric name | Metric unit | Metric help description | +|----------------------------------------------------|-------------|------------------------------------------------| +| nacos_exception_total{name='db'} | none | database exception | +| nacos_exception_total{name='configNotify'} | none | Nacos config notify exception | +| nacos_exception_total{name='unhealth'} | none | Nacos config server health check exception | +| nacos_exception_total{name='disk'} | none | Nacos naming write disk exception | +| nacos_exception_total{name='leaderSendBeatFailed'} | none | Nacos naming leader send heart beat fail count | +| nacos_exception_total{name='illegalArgument'} | none | request argument illegal count | +| nacos_exception_total{name='nacos'} | none | Nacos inner exception | #### Metric set：client -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| nacos_monitor{name='subServiceCount'} | none | subscribed services count | -| nacos_monitor{name='pubServiceCount'} | none | published services count | -| nacos_monitor{name='configListenSize'} | none | listened configuration file count | -| nacos_client_request_seconds_count | none | request count | -| nacos_client_request_seconds_sum | second | request time | - \ No newline at end of file +| Metric name | Metric unit | Metric help description | +|----------------------------------------|-------------|-----------------------------------| +| nacos_monitor{name='subServiceCount'} | none | subscribed services count | +| nacos_monitor{name='pubServiceCount'} | none | published services count | +| nacos_monitor{name='configListenSize'} | none | listened configuration file count | +| nacos_client_request_seconds_count | none | request count | +| nacos_client_request_seconds_sum | second | request time | + diff --git a/home/versioned_docs/version-v1.5.x/help/nebulagraph.md b/home/versioned_docs/version-v1.5.x/help/nebulagraph.md index ae2cfb4683f..c23e39c14fe 100644 --- a/home/versioned_docs/version-v1.5.x/help/nebulagraph.md +++ b/home/versioned_docs/version-v1.5.x/help/nebulagraph.md @@ -14,7 +14,7 @@ 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.** @@ -36,7 +36,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -55,7 +55,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat Too many indicators, related links are as follows **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** -| Metric name | Metric unit | Metric help description | +| 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. | @@ -67,8 +67,9 @@ Too many indicators, related links are as follows Too many indicators, related links are as follows **https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |----------------------------|-------------|-------------------------------------------------------------| | rocksdb.backup.read.bytes | | Number of bytes read during the RocksDB database backup. | | rocksdb.backup.write.bytes | | Number of bytes written during the RocksDB database backup. | | ... | | ... | + diff --git a/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md b/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md index d0da21a7adb..c39195f427e 100644 --- a/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md +++ b/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md @@ -11,7 +11,7 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open ### Configuration parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------| | Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | | Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | @@ -35,21 +35,21 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open #### Metric Set: Session -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------------|-------------|----------------------------------| | session | None | Number of sessions | | running_query_count | None | Number of queries being executed | #### Metric Set: Jobs -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |--------------|-------------|-------------------------------------------| | queue_jobs | None | Number of pending background tasks | | running_jobs | None | Number of background tasks being executed | #### Metric Set: Cluster node info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------------|-------------|---------------------------------| | total_storage_node | None | Number of storage nodes | | offline_storage_node | None | Number of offline storage nodes | @@ -60,7 +60,7 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open #### Metric Set: Storage Nodes -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-----------------------|-------------|-------------------------------------------------------| | host | None | Node address | | port | None | Port | @@ -89,3 +89,4 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open | version | None | Version | > If you need to customize monitoring templates to collect data from NebulaGraph clusters, please refer to: [NGQL Custom Monitoring](../advanced/extend-ngql.md) + diff --git a/home/versioned_docs/version-v1.5.x/help/nginx.md b/home/versioned_docs/version-v1.5.x/help/nginx.md index 99bb389000c..f630e4d4d24 100644 --- a/home/versioned_docs/version-v1.5.x/help/nginx.md +++ b/home/versioned_docs/version-v1.5.x/help/nginx.md @@ -20,6 +20,7 @@ If you want to monitor information in 'Nginx' with this monitoring type, you nee ```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 @@ -50,6 +51,7 @@ server { } } ``` + 4. Reload Nginx ```shell @@ -107,14 +109,13 @@ nginx -s reload 4. Access `http://localhost/req-status` in the browser to view the Nginx monitoring status information. - **Refer Doc: https://github.com/zls0424/ngx_req_status** **⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -128,28 +129,27 @@ nginx -s reload #### 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 | +| 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------| +| zone_name | | Group category | +| key | | Group name | +| max_active | | Maximum concurrent connections | +| max_bw | kb | Maximum bandwidth | +| traffic | kb | Total traffic | +| requests | | Total requests | +| active | | Current concurrent connections | +| bandwidth | kb | Current bandwidth | diff --git a/home/versioned_docs/version-v1.5.x/help/ntp.md b/home/versioned_docs/version-v1.5.x/help/ntp.md index 5eca6c58e80..666f2a6b39a 100644 --- a/home/versioned_docs/version-v1.5.x/help/ntp.md +++ b/home/versioned_docs/version-v1.5.x/help/ntp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -23,7 +23,7 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito #### Metrics Set：summary -| Metric name | Metric unit | Metric help description | +| 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). | diff --git a/home/versioned_docs/version-v1.5.x/help/openai.md b/home/versioned_docs/version-v1.5.x/help/openai.md index 7fc70548645..7165925372f 100644 --- a/home/versioned_docs/version-v1.5.x/help/openai.md +++ b/home/versioned_docs/version-v1.5.x/help/openai.md @@ -8,6 +8,7 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI ### Preparation #### Obtain Session Key + > 1. Open Chrome browser's network request interface > `Mac: cmd + option + i` > `Windows: ctrl + shift + i` @@ -22,7 +23,7 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI ### Configuration Parameters -| Parameter Name | Parameter Description | +| Parameter Name | Parameter Description | |:------------------|------------------------------------------------------------------------------------------------| | Monitoring Host | Fill in api.openai.com here. | | Task Name | Identify the name of this monitoring, ensuring uniqueness. | @@ -36,7 +37,7 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI #### Metric Set: Credit Grants -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |----------------------|-------------|--------------------------------------| | Total Granted | USD ($) | Total granted credit limit | | Total Used | USD ($) | Total used credit limit | @@ -45,14 +46,14 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI #### Metric Set: Model Cost -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |-------------|-------------|------------------------| | Model Name | None | Name of the model | | Cost | USD ($) | Expenses for the model | #### Metric Set: Billing Subscription -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |--------------------------|-------------|-----------------------------------------| | Has Payment Method | None | Whether payment method is available | | Canceled | None | Whether subscription is cancelled | @@ -80,3 +81,4 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI | Tax IDs | None | Tax IDs | | Billing Address | None | Billing address | | Business Address | None | Business address | + diff --git a/home/versioned_docs/version-v1.5.x/help/opengauss.md b/home/versioned_docs/version-v1.5.x/help/opengauss.md index 650882861e8..28171658951 100644 --- a/home/versioned_docs/version-v1.5.x/help/opengauss.md +++ b/home/versioned_docs/version-v1.5.x/help/opengauss.md @@ -5,54 +5,52 @@ 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. +> 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | diff --git a/home/versioned_docs/version-v1.5.x/help/opensuse.md b/home/versioned_docs/version-v1.5.x/help/opensuse.md index e4220262e67..acaf86632d4 100644 --- a/home/versioned_docs/version-v1.5.x/help/opensuse.md +++ b/home/versioned_docs/version-v1.5.x/help/opensuse.md @@ -4,103 +4,105 @@ title: Monitoring OpenSUSE Operating System Monitoring sidebar_label: OpenSUSE OS keywords: [open source monitoring system, open source operating system monitoring, OpenSUSE OS monitoring] --- + > Collect and monitor general performance metrics of the OpenSUSE operating system. ### Configuration Parameters -| Parameter Name | Parameter Help Description | -| -------------- | ---------------------------------------------------------------------------- | -| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). | -| Task Name | The name that identifies this monitoring, which must be unique. | -| Port | The port provided by Linux SSH, default is 22. | -| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. | -| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. | -| Username | SSH connection username, optional. | -| Password | SSH connection password, optional. | -| Collector | Configures which collector is used to schedule data collection for this monitoring. | -| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | -| Binding Tags | Used for categorized management of monitoring resources. | -| Description | Additional notes and descriptions for this monitoring, where users can make notes. | -| Key | The key required to connect to the server. | +| Parameter Name | Parameter Help Description | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). | +| Task Name | The name that identifies this monitoring, which must be unique. | +| Port | The port provided by Linux SSH, default is 22. | +| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. | +| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Configures which collector is used to schedule data collection for this monitoring. | +| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | +| Binding Tags | Used for categorized management of monitoring resources. | +| Description | Additional notes and descriptions for this monitoring, where users can make notes. | +| Key | The key required to connect to the server. | ### Collection Metrics #### Metric Set: System Basic Information -| Metric Name | Unit | Metric Help Description | -| --------------- | ------- | ------------------------ | -| Host Name | None | Host name | -| System Version | None | Operating system version| -| Uptime | None | Uptime | +| Metric Name | Unit | Metric Help Description | +|----------------|------|--------------------------| +| Host Name | None | Host name | +| System Version | None | Operating system version | +| Uptime | None | Uptime | #### Metric Set: CPU Information -| Metric Name | Unit | Metric Help Description | -| --------------- | ----- | ---------------------------------- | -| info | None | CPU model | -| cores | Cores | Number of CPU cores | -| interrupt | Count | Number of CPU interrupts | -| load | None | Average CPU load over the last 1/5/15 minutes | -| context_switch | Count | Number of context switches | -| usage | % | CPU usage rate | +| Metric Name | Unit | Metric Help Description | +|----------------|-------|-----------------------------------------------| +| info | None | CPU model | +| cores | Cores | Number of CPU cores | +| interrupt | Count | Number of CPU interrupts | +| load | None | Average CPU load over the last 1/5/15 minutes | +| context_switch | Count | Number of context switches | +| usage | % | CPU usage rate | #### Metric Set: Memory Information -| Metric Name | Unit | Metric Help Description | -| ----------- | ---- | ------------------------ | -| total | Mb | Total memory capacity | -| used | Mb | Memory used by user programs | -| free | Mb | Free memory capacity | -| buff_cache | Mb | Memory used for cache | +| Metric Name | Unit | Metric Help Description | +|-------------|------|-------------------------------------| +| total | Mb | Total memory capacity | +| used | Mb | Memory used by user programs | +| free | Mb | Free memory capacity | +| buff_cache | Mb | Memory used for cache | | available | Mb | Remaining available memory capacity | -| usage | % | Memory usage rate | +| usage | % | Memory usage rate | #### Metric Set: Disk Information -| Metric Name | Unit | Metric Help Description | -| --------------- | ----- | ----------------------------- | -| disk_num | Count | Total number of disks | -| partition_num | Count | Total number of partitions | -| block_write | Count | Total number of blocks written to disk | -| block_read | Count | Total number of blocks read from disk | -| write_rate | iops | Disk block write rate per second | +| Metric Name | Unit | Metric Help Description | +|---------------|-------|----------------------------------------| +| disk_num | Count | Total number of disks | +| partition_num | Count | Total number of partitions | +| block_write | Count | Total number of blocks written to disk | +| block_read | Count | Total number of blocks read from disk | +| write_rate | iops | Disk block write rate per second | #### Metric Set: Network Card Information -| Metric Name | Unit | Metric Help Description | -| ------------------- | ---- | -------------------------- | -| interface_name | None | Network card name | -| receive_bytes | Mb | Inbound data traffic | -| transmit_bytes | Mb | Outbound data traffic | +| Metric Name | Unit | Metric Help Description | +|----------------|------|-------------------------| +| interface_name | None | Network card name | +| receive_bytes | Mb | Inbound data traffic | +| transmit_bytes | Mb | Outbound data traffic | #### Metric Set: File System | Metric Name | Unit | Metric Help Description | -| ---------- | ---- | ------------------------ | -| filesystem | None | Name of the file system | -| used | Mb | Used disk size | -| available | Mb | Available disk size | -| usage | % | Usage rate | -| mounted | None | Mount point directory | +|-------------|------|-------------------------| +| filesystem | None | Name of the file system | +| used | Mb | Used disk size | +| available | Mb | Available disk size | +| usage | % | Usage rate | +| mounted | None | Mount point directory | #### Metric Set: Top 10 CPU Processes Statistics for the top 10 processes using the CPU. Statistics include: Process ID, CPU usage, memory usage, executed command. -| Metric Name | Unit | Metric Help Description | -| ------------ | ---- | ------------------------ | -| pid | None | Process ID | -| cpu_usage | % | CPU usage rate | -| mem_usage | % | Memory usage rate | -| command | None | Executed command | +| Metric Name | Unit | Metric Help Description | +|-------------|------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage rate | +| mem_usage | % | Memory usage rate | +| command | None | Executed command | #### Metric Set: Top 10 Memory Processes Statistics for the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command. -| Metric Name | Unit | Metric Help Description | -| ------------ | ---- | ------------------------ | -| pid | None | Process ID | -| mem_usage | % | Memory usage rate | -| cpu_usage | % | CPU usage rate | -| command | None | Executed command | \ No newline at end of file +| Metric Name | Unit | Metric Help Description | +|-------------|------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage rate | +| cpu_usage | % | CPU usage rate | +| command | None | Executed command | + diff --git a/home/versioned_docs/version-v1.5.x/help/oracle.md b/home/versioned_docs/version-v1.5.x/help/oracle.md index 5410e53decb..50d2f6422bc 100644 --- a/home/versioned_docs/version-v1.5.x/help/oracle.md +++ b/home/versioned_docs/version-v1.5.x/help/oracle.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -27,37 +27,38 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo #### 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 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 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 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 | +| 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.5.x/help/ping.md b/home/versioned_docs/version-v1.5.x/help/ping.md index c5603fdfbce..7c894f488ff 100644 --- a/home/versioned_docs/version-v1.5.x/help/ping.md +++ b/home/versioned_docs/version-v1.5.x/help/ping.md @@ -5,32 +5,33 @@ 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. +> 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 | +| 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 | - +| 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 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address + diff --git a/home/versioned_docs/version-v1.5.x/help/plugin.md b/home/versioned_docs/version-v1.5.x/help/plugin.md index b8104a3594a..6c0f938c7a4 100644 --- a/home/versioned_docs/version-v1.5.x/help/plugin.md +++ b/home/versioned_docs/version-v1.5.x/help/plugin.md @@ -1,10 +1,11 @@ --- id: plugin title: Custom plugin -sidebar_label: Custom plugin +sidebar_label: Custom plugin --- ## Custom plugins + ### Introduction Currently, `Hertzbeat` relies on the `alert` module to notify the user, and then the user can take actions such as sending requests, executing `sql`, executing `shell` scripts, etc. However, this can only be automated manually or by `webhook` to receive the alert message. @@ -13,6 +14,7 @@ After adding the customized code, you only need to package the `plugin` module, Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if you need to set up the trigger method at the time of acquisition, startup program, etc., please mention `Task` in `https://github.com/apache/hertzbeat/issues/new/choose`. ### Specific uses + 1. Pull the master branch code `git clone https://github.com/apache/hertzbeat.git` and locate the `plugin` module's `Plugin` interface. ![plugin-1.png](/img/docs/help/plugin-1.png) @@ -23,3 +25,4 @@ Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if yo 4. Copy the packaged `jar` package to the `ext-lib` directory under the installation directory (for `docker` installations, mount the `ext-lib` directory first, then copy it there). ![plugin-4.png](/img/docs/help/plugin-4.png) 5. Then restart `HertzBeat` to enable the customized post-alert handling policy. + diff --git a/home/versioned_docs/version-v1.5.x/help/pop3.md b/home/versioned_docs/version-v1.5.x/help/pop3.md index 822192ad66d..fffff2a494f 100644 --- a/home/versioned_docs/version-v1.5.x/help/pop3.md +++ b/home/versioned_docs/version-v1.5.x/help/pop3.md @@ -24,10 +24,9 @@ If you want to monitor information in 'POP3' with this monitoring type, you just 5. 通过POP3服务器域名，端口号，qq邮箱账号以及授权码连接POP3服务器，采集监控指标 ``` - ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -42,9 +41,8 @@ If you want to monitor information in 'POP3' with this monitoring type, you just #### 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 | - +| 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.5.x/help/port.md b/home/versioned_docs/version-v1.5.x/help/port.md index e3350a8776f..7f420fd1375 100644 --- a/home/versioned_docs/version-v1.5.x/help/port.md +++ b/home/versioned_docs/version-v1.5.x/help/port.md @@ -7,25 +7,23 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito > 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 | +### 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 | - - +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | diff --git a/home/versioned_docs/version-v1.5.x/help/postgresql.md b/home/versioned_docs/version-v1.5.x/help/postgresql.md index de14f9d62eb..57834a713bd 100644 --- a/home/versioned_docs/version-v1.5.x/help/postgresql.md +++ b/home/versioned_docs/version-v1.5.x/help/postgresql.md @@ -9,50 +9,48 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------------------| +| running | connections | Number of current client connections | diff --git a/home/versioned_docs/version-v1.5.x/help/process.md b/home/versioned_docs/version-v1.5.x/help/process.md index 599c4f1ea7b..825a20ac43b 100644 --- a/home/versioned_docs/version-v1.5.x/help/process.md +++ b/home/versioned_docs/version-v1.5.x/help/process.md @@ -4,34 +4,33 @@ title: Monitoring Linux Process Monitoring sidebar_label: Process keywords: [Open Source Monitoring System, Operating System Process Monitoring, Process Monitoring] --- + > Collect and monitor basic information of processes on Linux systems, including CPU usage, memory usage, physical memory, IO, etc. ## Configuration Parameters - -| Parameter Name | Parameter Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️: Do not include the protocol header (e.g., https://, http://). | -| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | -| Port | SSH port of the Linux system, default: 22 | -| Timeout | Sets the timeout for the connection in milliseconds, default is 6000 milliseconds. | -| Reuse Connection | Sets whether SSH connection is reused, default is false. When false, a new connection is created for each information retrieval. | -| Username | Username for the server. | -| Password | Password for the server. | -| Process Name | Name or part of the name of the process to be monitored. | -| Collector | Specifies which collector to use for scheduling this monitoring. | -| Monitoring Interval | Interval for periodic data collection, in seconds. Minimum interval that can be set is 30 seconds. | -| Tags | Used for categorizing and managing monitoring resources. | -| Description | Additional notes and descriptions for identifying this monitoring. Users can add remarks here. | -| Private Key | Private key required for connecting to the server. | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Port | SSH port of the Linux system, default: 22 | +| Timeout | Sets the timeout for the connection in milliseconds, default is 6000 milliseconds. | +| Reuse Connection | Sets whether SSH connection is reused, default is false. When false, a new connection is created for each information retrieval. | +| Username | Username for the server. | +| Password | Password for the server. | +| Process Name | Name or part of the name of the process to be monitored. | +| Collector | Specifies which collector to use for scheduling this monitoring. | +| Monitoring Interval | Interval for periodic data collection, in seconds. Minimum interval that can be set is 30 seconds. | +| Tags | Used for categorizing and managing monitoring resources. | +| Description | Additional notes and descriptions for identifying this monitoring. Users can add remarks here. | +| Private Key | Private key required for connecting to the server. | ### Metrics Collected #### Metric Set: Process Basic Information - | Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | ------------------ | +|-------------|-------------|--------------------| | PID | NONE | Process ID | | User | NONE | User | | CPU | NONE | CPU Usage | @@ -41,9 +40,8 @@ keywords: [Open Source Monitoring System, Operating System Process Monitoring, P #### Metric Set: Memory Usage Information - | Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | ------------------ | +|-------------|-------------|--------------------| | PID | NONE | Process ID | | detail | NONE | Detailed metrics | @@ -63,9 +61,8 @@ Includes metrics for: #### Metric Set: Other Monitoring Information - -| Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | --------------------------------- | +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|-----------------------------------| | PID | NONE | Process ID | | path | NONE | Execution Path | | date | NONE | Start Time | @@ -73,9 +70,8 @@ Includes metrics for: #### Metric Set: IO - | Metric Name | Metric Unit | Metric Description | -| ----------- | ----------- | ------------------ | +|-------------|-------------|--------------------| | PID | NONE | Process ID | | metric | NONE | Metric Name | | value | NONE | Metric Value | @@ -89,3 +85,4 @@ Includes metrics for: - read_bytes (Actual number of bytes read by the process from disk) - write_bytes (Actual number of bytes written by the process to disk) - cancelled_write_bytes (Actual number of bytes cancelled by the process while writing to disk) + diff --git a/home/versioned_docs/version-v1.5.x/help/prometheus.md b/home/versioned_docs/version-v1.5.x/help/prometheus.md index 4de9f80f67d..571a2e9b51b 100755 --- a/home/versioned_docs/version-v1.5.x/help/prometheus.md +++ b/home/versioned_docs/version-v1.5.x/help/prometheus.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, Prometheus protocol monitoring ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | | Task Name | Identify the name of this monitoring. The name needs to be unique. | @@ -40,5 +40,3 @@ You can use the following configuration: Keep the rest of the settings default. - - diff --git a/home/versioned_docs/version-v1.5.x/help/pulsar.md b/home/versioned_docs/version-v1.5.x/help/pulsar.md index 2cc520d6189..1424bd3f58b 100644 --- a/home/versioned_docs/version-v1.5.x/help/pulsar.md +++ b/home/versioned_docs/version-v1.5.x/help/pulsar.md @@ -4,52 +4,48 @@ title: Monitoring Pulsar Monitoring sidebar_label: Apache Pulsar keywords: [open-source monitoring system, open-source database monitoring, HbaseMaster monitoring] --- + > Collecting and monitoring general performance metrics of Pulsar **Protocol Used: HTTP** ## Configuration Parameters - -| Parameter Name | Description | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| Parameter Name | Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------| | Target Host | The monitored endpoint's IPV4, IPV6, or domain name. Note⚠️: Do not include the protocol header (e.g., https://, http://). | -| Port | The webServicePort value of Pulsar, default is 8080. | -| Task Name | The name identifying this monitoring task, must be unique. | -| Query Timeout | Set the connection timeout in milliseconds, default is 3000 milliseconds. | -| Monitoring Interval | Interval time for periodic data collection, in seconds, minimum interval is 30 seconds. | -| Binding Tags | Used for categorizing monitoring resources. | -| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add more information here. | +| Port | The webServicePort value of Pulsar, default is 8080. | +| Task Name | The name identifying this monitoring task, must be unique. | +| Query Timeout | Set the connection timeout in milliseconds, default is 3000 milliseconds. | +| Monitoring Interval | Interval time for periodic data collection, in seconds, minimum interval is 30 seconds. | +| Binding Tags | Used for categorizing monitoring resources. | +| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add more information here. | ### Collected Metrics #### Metric Set: Version Information - -| Metric Name | Unit | Description | -| ------------ | ---- | ------------------- | -| Version Info | NONE | Version Information | +| Metric Name | Unit | Description | +|--------------|------|---------------------| +| Version Info | NONE | Version Information | #### Metric Set: process_start_time_seconds - -| Metric Name | Unit | Description | -| ------------------ | ---- | ------------------ | -| Process Start Time | NONE | Process Start Time | +| Metric Name | Unit | Description | +|--------------------|------|--------------------| +| Process Start Time | NONE | Process Start Time | #### Metric Set: process_open_fds - -| Metric Name | Unit | Description | -| --------------------- | ---- | ------------------------------- | -| Open File Descriptors | NONE | Number of Open File Descriptors | +| Metric Name | Unit | Description | +|-----------------------|------|---------------------------------| +| Open File Descriptors | NONE | Number of Open File Descriptors | #### Metric Set: process_max_fds - -| Metric Name | Unit | Description | -| -------------------- | ---- | ---------------------------------- | -| Max File Descriptors | NONE | Maximum Number of File Descriptors | +| Metric Name | Unit | Description | +|----------------------|------|------------------------------------| +| Max File Descriptors | NONE | Maximum Number of File Descriptors | #### Metric Set: jvm_memory_pool_allocated_bytes diff --git a/home/versioned_docs/version-v1.5.x/help/rabbitmq.md b/home/versioned_docs/version-v1.5.x/help/rabbitmq.md index 1bcd3ea5851..917ca63c3d3 100644 --- a/home/versioned_docs/version-v1.5.x/help/rabbitmq.md +++ b/home/versioned_docs/version-v1.5.x/help/rabbitmq.md @@ -7,7 +7,7 @@ keywords: [open source monitoring tool, open source rabbitmq monitoring tool, mo > Monitoring the running status of RabbitMQ message middleware, nodes, topics and other related metrics. -### Pre-monitoring Operations +### 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 @@ -24,7 +24,7 @@ rabbitmq-plugins enable rabbitmq_management ### Configuration parameters -| Parameter name | Parameter help description | +| 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. | @@ -40,7 +40,7 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: overview -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |--------------------|-------------|------------------------------------| | product_version | None | Product Version | | product_name | None | Product name | @@ -52,7 +52,7 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: object_totals -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |-------------|-------------|-----------------------------| | channels | none | total number of channels | | connections | none | total number of connections | @@ -62,24 +62,24 @@ rabbitmq-plugins enable rabbitmq_management #### metrics: nodes -| Metric Name | Metric Unit | Metric Description | +| 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 | +| 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 | +| 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 | +| 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 | @@ -100,27 +100,27 @@ rabbitmq-plugins enable rabbitmq_management | queue_deleted | None | queue deleted num | | connection_closed | None | connection closed num | - #### metrics: queues -| Metric Name | Metric Unit | Metric Description | +| Metric Name | Metric Unit | Metric Description | |------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------| -| name | None | The name of the queue with non-ASCII characters escaped as in C. | +| 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. | +| 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 | +| 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. | +| 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_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_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 | 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_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | + diff --git a/home/versioned_docs/version-v1.5.x/help/redhat.md b/home/versioned_docs/version-v1.5.x/help/redhat.md index d877c46df36..2a8472e00d6 100644 --- a/home/versioned_docs/version-v1.5.x/help/redhat.md +++ b/home/versioned_docs/version-v1.5.x/help/redhat.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitoring, ensuring uniqueness. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|---------------------------| | Host Name | None | Host name. | | System Version | None | Operating system version. | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|-------------------------------------------| | info | None | CPU model. | | cores | None | Number of CPU cores. | @@ -47,7 +47,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Memory Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|------------------------------------| | total | Mb | Total memory capacity. | | used | Mb | Used memory by user programs. | @@ -58,7 +58,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Disk Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------|-------------|------------------------------------| | disk_num | None | Total number of disks. | | partition_num | None | Total number of partitions. | @@ -68,7 +68,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS #### Metric Set: Interface Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------------| | interface_name | None | Name of the network interface. | | receive_bytes | Mb | Inbound data traffic. | @@ -105,3 +105,4 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/versioned_docs/version-v1.5.x/help/redis.md b/home/versioned_docs/version-v1.5.x/help/redis.md index de0df0d52ca..bdb78ce3584 100644 --- a/home/versioned_docs/version-v1.5.x/help/redis.md +++ b/home/versioned_docs/version-v1.5.x/help/redis.md @@ -2,244 +2,239 @@ id: redis title: 监控：REDIS数据库监控 sidebar_label: REDIS -keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] --- > 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 ### 配置参数 -| 参数名称 | 参数帮助描述 | -| ----------- | ----------- | -| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 | -| 端口 | redis对外提供的端口，默认为6379,sentinel节点默认26379 | -| 超时时间 | 设置redis info 查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。 | -| 数据库名称 | 数据库实例名称，可选。 | -| 用户名 | 数据库连接用户名，可选 | -| 密码 | 数据库连接密码，可选 | -| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 | -| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 | -| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 | +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控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 | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------|------|-----------------------------------------------| +| 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 | 无 | 客户端超时表中的客户端数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|--------------------------------------------------------------------------------| +| 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 | 无 | 已延迟释放的对象数。| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|----------|-----------------------------------------------------------------------------------------------| +| 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操作期间写入时复制内存的字节大小 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------------------|--------|-----------------------------------------------------------------------------------------------------| +| 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 | 无 | 正在写入的线程数 | - +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|----------------------------------------------------| +| 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的大小 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------------------------|------|-------------------------------------------------------------------------------------| +| 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 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|------|------------------------| +| 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 | 无 | | +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|-----------| +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | #### 指标集合：cluster -| 指标名称 | 指标单位 | 指标帮助描述 | -| ----------- | ----------- | ----------- | -| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| - +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------------------| +| 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命令的统计信息 | +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------------------------------------------------------------------------------------------------------------------------| +| cmdstat_set | 无 | set命令的统计信息，calls: 累计调用该命令的次数；usec: 调用该命令的累计耗时,单位微秒；usec_per_call: 调用该命令的平均耗时；rejected_call: 拒绝执行的次数；failed_calls: 调用失败的次数 | +| cmdstat_get | 无 | get命令的统计信息 | +| cmdstat_setnx | 无 | setnx命令的统计信息 | +| cmdstat_hset | 无 | hset命令的统计信息 | +| cmdstat_hget | 无 | hget命令的统计信息 | +| cmdstat_lpush | 无 | lpush命令的统计信息 | +| cmdstat_rpush | 无 | rpush命令的统计信息 | +| cmdstat_lpop | 无 | lpop命令的统计信息 | +| cmdstat_rpop | 无 | rpop命令的统计信息 | +| cmdstat_llen | 无 | llen命令的统计信息 | + diff --git a/home/versioned_docs/version-v1.5.x/help/rocketmq.md b/home/versioned_docs/version-v1.5.x/help/rocketmq.md index f56bdfc2f14..f31dea47d9b 100644 --- a/home/versioned_docs/version-v1.5.x/help/rocketmq.md +++ b/home/versioned_docs/version-v1.5.x/help/rocketmq.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] ### Configuration parameters -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------|--------------------------------------------------------------------------------------------------------------------------| | Namesrv Host | IPV4,IPV6 of RocketMQ name server(eg: https://, http://)。 | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -24,7 +24,7 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] #### Metric set：cluster -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|---------------------------------------| | BrokerId | none | Broker id | | Address | none | Broker address | @@ -38,7 +38,7 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] #### Metric set：Consumer -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |-----------------|-------------|-------------------------| | Consumer_group | none | Consumer group | | Client_quantity | none | Number of clients | @@ -46,3 +46,4 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] | Consume_type | none | Consume type | | Consume_tps | none | Consume tps | | Delay | none | Delay | + diff --git a/home/versioned_docs/version-v1.5.x/help/rockylinux.md b/home/versioned_docs/version-v1.5.x/help/rockylinux.md index f83eb606b0a..b1e093bc210 100644 --- a/home/versioned_docs/version-v1.5.x/help/rockylinux.md +++ b/home/versioned_docs/version-v1.5.x/help/rockylinux.md @@ -9,7 +9,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu ### Configuration Parameters -| Parameter Name | Parameter help description | +| Parameter Name | Parameter help description | |---------------------|----------------------------------------------------------------------------------------------------------------------------------| | Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitoring, ensuring uniqueness. | @@ -28,7 +28,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Basic Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|---------------------------| | Host Name | None | Host name. | | System Version | None | Operating system version. | @@ -36,7 +36,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: CPU Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|-------------------------------------------| | info | None | CPU model. | | cores | None | Number of CPU cores. | @@ -47,7 +47,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Memory Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |-------------|-------------|------------------------------------| | total | Mb | Total memory capacity. | | used | Mb | Used memory by user programs. | @@ -58,7 +58,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Disk Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |---------------|-------------|------------------------------------| | disk_num | None | Total number of disks. | | partition_num | None | Total number of partitions. | @@ -68,7 +68,7 @@ keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linu #### Metric Set: Interface Info -| Metric Name | Metric Unit | Metric help description | +| Metric Name | Metric Unit | Metric help description | |----------------|-------------|--------------------------------| | interface_name | None | Name of the network interface. | | receive_bytes | Mb | Inbound data traffic. | @@ -105,3 +105,4 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | + diff --git a/home/versioned_docs/version-v1.5.x/help/shenyu.md b/home/versioned_docs/version-v1.5.x/help/shenyu.md index 01523769c78..c7f12bbfaf0 100644 --- a/home/versioned_docs/version-v1.5.x/help/shenyu.md +++ b/home/versioned_docs/version-v1.5.x/help/shenyu.md @@ -5,27 +5,27 @@ 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. +> monitor ShenYu running status(JVM-related), include request response and other related metrics. -## Pre-monitoring operations +## Pre-monitoring operations -Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 +Enable `metrics` plugin in ShenYu, expose it's prometheus metrics endpoint。 -Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) +Refer [ShenYu Document](https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin) -Two Steps Mainly: +Two Steps Mainly: -1. add metrics plugin dependency in gateway's pom.xml. +1. add metrics plugin dependency in gateway's pom.xml. ```xml - - org.apache.shenyu - shenyu-spring-boot-starter-plugin-metrics - ${project.version} - + + org.apache.shenyu + shenyu-spring-boot-starter-plugin-metrics + ${project.version} + ``` -2. modify this config in shenyu gateway yaml. +2. modify this config in shenyu gateway yaml. ```yaml shenyu: @@ -57,75 +57,74 @@ Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond #### Index collection: shenyu_request_total -| Metric Name | Metric Unit | Metric Help Description | -| ----------- |------|-------------------| -| value | None | Collect all requests from ShenYu gateway | +| 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 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 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 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 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 | +|-------------|-------------|-------------------------| +| 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 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 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 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 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 | - +| 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.5.x/help/smtp.md b/home/versioned_docs/version-v1.5.x/help/smtp.md index 971de82c3e0..fedb17e0040 100644 --- a/home/versioned_docs/version-v1.5.x/help/smtp.md +++ b/home/versioned_docs/version-v1.5.x/help/smtp.md @@ -13,12 +13,11 @@ Determine whether the server is available through the hello command in SMTP > see https://datatracker.ietf.org/doc/html/rfc821#page-13 - **Protocol Use：SMTP** ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -33,7 +32,7 @@ Determine whether the server is available through the hello command in SMTP #### Metrics Set：summary -| Metric name | Metric unit | Metric help description | +| 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. | diff --git a/home/versioned_docs/version-v1.5.x/help/spark.md b/home/versioned_docs/version-v1.5.x/help/spark.md index 3d4b44828ea..41865300024 100644 --- a/home/versioned_docs/version-v1.5.x/help/spark.md +++ b/home/versioned_docs/version-v1.5.x/help/spark.md @@ -15,12 +15,9 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, Refer: https://spark.apache.org/docs/latest/spark-standalone.html - **监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** - - ## 第一步 **修改$SPARK_HOME/conf/spark-env.sh，添加以下语句：** @@ -36,8 +33,6 @@ export SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.manageme 语句中有$JMX_PORT，这个的值可以自定义，也可以获取一个随机数作为端口号。 如果端口自定义为一个具体的值，而 spark 的 Master 和其中之一的 Worker 在同一台机器上，会出现端口冲突的情况。 - - ## 第二步 **vim $SPARK_HOME/conf/metrics.properties 添加如下内容** @@ -50,10 +45,6 @@ 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设置监控端口，在有程序运行的情况下，此端口会被打开。** @@ -69,11 +60,9 @@ gement.jmxremote.port=8711 在spark的Master和Worker正常运行以及spark-submit提交了一个程序的情况下，可以从linux中查询出端口号码。 - - ### Configuration parameter -| Parameter name | Parameter help description | +| 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 | @@ -107,16 +96,15 @@ gement.jmxremote.port=8711 #### Metrics Set：class_loading -| Metric name | Metric unit | Metric help description | +| 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 | +| Metric name | Metric unit | Metric help description | |-------------------------|-------------|----------------------------| | TotalStartedThreadCount | | Total Started Thread Count | | ThreadCount | | Thread Count | @@ -125,4 +113,3 @@ gement.jmxremote.port=8711 | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.5.x/help/spring_gateway.md b/home/versioned_docs/version-v1.5.x/help/spring_gateway.md index ae24228c222..66c5f0b4f29 100644 --- a/home/versioned_docs/version-v1.5.x/help/spring_gateway.md +++ b/home/versioned_docs/version-v1.5.x/help/spring_gateway.md @@ -19,6 +19,7 @@ If you want to monitor information in 'Spring Gateway' with this monitoring type spring-boot-starter-actuator ``` + **2. Modify the YML configuration exposure metric interface:** ```yaml @@ -35,56 +36,55 @@ management: ### 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 | +| 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 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 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 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 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 | - +| Metric Name | metric unit | Metrics help describe | +|-------------|-------------|---------------------------------------| +| route_id | None | Route id | +| predicate | None | This is a routing matching rule | +| uri | None | This is a service resource identifier | +| order | None | The priority of this route | diff --git a/home/versioned_docs/version-v1.5.x/help/springboot2.md b/home/versioned_docs/version-v1.5.x/help/springboot2.md index ca46530f77b..6452aff270e 100644 --- a/home/versioned_docs/version-v1.5.x/help/springboot2.md +++ b/home/versioned_docs/version-v1.5.x/help/springboot2.md @@ -19,6 +19,7 @@ If you want to monitor information in 'SpringBoot' with this monitoring type, yo spring-boot-starter-actuator ``` + **2. Modify the YML configuration exposure metric interface:** ```yaml @@ -29,7 +30,9 @@ management: 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 @@ -45,47 +48,49 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ } } ``` + ### 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 | +| 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 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 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 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 Name | metric unit | Metrics help describe | +|-------------|-------------|--------------------------------------| +| space | None | Memory space name | +| mem_used | MB | This space occupies a memory size of | + diff --git a/home/versioned_docs/version-v1.5.x/help/springboot3.md b/home/versioned_docs/version-v1.5.x/help/springboot3.md index 0dbc32fc834..47b3db10b5c 100644 --- a/home/versioned_docs/version-v1.5.x/help/springboot3.md +++ b/home/versioned_docs/version-v1.5.x/help/springboot3.md @@ -51,7 +51,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### Configuration Parameters -| Parameter Name | Parameter Description | +| Parameter Name | Parameter Description | |-------------------|----------------------------------------------------------------------------------------------------------------------| | Monitor Host | The monitored peer's IPV4, IPV6, or domain name. Note⚠️: Do not include protocol headers (eg: https://, http://). | | Task Name | Identifies the name of this monitor, ensuring uniqueness is necessary. | @@ -65,23 +65,28 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ ### Collection Metrics #### Metric Set: Availability + | Metric Name | Unit | Metric Description | |--------------|------|--------------------| | responseTime | ms | Response time | #### Metric Set: Threads -| Metric Name | Unit | Metric Description | + +| Metric Name | Unit | Metric Description | |-------------|------|----------------------------------| | state | None | Thread state | | size | None | Number of threads for this state | #### Metric Set: Memory Usage -| Metric Name | Unit | Metric Description | + +| Metric Name | Unit | Metric Description | |-------------|------|-----------------------------| | space | None | Memory space name | | mem_used | MB | Memory usage for this space | #### Metric Set: Health Status -| Metric Name | Unit | Metric Description | + +| Metric Name | Unit | Metric Description | |-------------|------|---------------------------------| | status | None | Service health status: UP, Down | + diff --git a/home/versioned_docs/version-v1.5.x/help/sqlserver.md b/home/versioned_docs/version-v1.5.x/help/sqlserver.md index cc12abf0d7e..71bd8ebdc83 100644 --- a/home/versioned_docs/version-v1.5.x/help/sqlserver.md +++ b/home/versioned_docs/version-v1.5.x/help/sqlserver.md @@ -9,51 +9,49 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### 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 | +| 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 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 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 | - +| Metric name | Metric unit | Metric help description | +|-----------------|-------------|------------------------------| +| user_connection | none | Number of connected sessions | ### Common Problem @@ -61,10 +59,12 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo jdk version: jdk11 Description of the problem: SQL Server 2019 uses the SA user connection to report an error -Error message: +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) diff --git a/home/versioned_docs/version-v1.5.x/help/ssl_cert.md b/home/versioned_docs/version-v1.5.x/help/ssl_cert.md index 7265bd12a59..e7b60fc8a89 100644 --- a/home/versioned_docs/version-v1.5.x/help/ssl_cert.md +++ b/home/versioned_docs/version-v1.5.x/help/ssl_cert.md @@ -9,25 +9,26 @@ keywords: [open source monitoring tool, open source ssl cert monitoring tool, mo ### 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 | +| 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 | +| 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.5.x/help/tidb.md b/home/versioned_docs/version-v1.5.x/help/tidb.md index 541b84d6876..83128c527c8 100644 --- a/home/versioned_docs/version-v1.5.x/help/tidb.md +++ b/home/versioned_docs/version-v1.5.x/help/tidb.md @@ -17,22 +17,21 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### Configuration parameter -| Parameter name | Parameter help description | -| ----------- | ----------- | -| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | -| Task name | Identify the name of this monitoring. The name needs to be unique | -| Service Port | The port that the TiDB database provides externally for status reporting is 10080 by default | -| PD Port | The PD port for the TiDB database, which defaults to 2379 | -| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms | -| JDBC Port | The TiDB database externally provides the port used for client requests, which defaults to 4000 | -| Database name | Database instance name, optional | -| Username | Database connection user name, optional | -| Password | Database connection password, optional | -| JDBC URL | Database using [JDBC](https://docs.pingcap.com/tidb/stable/dev-guide-connect-to-tidb#jdbc) connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | -| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | -| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | -| Description remarks | For more information about identifying and describing this monitoring, users can note information here | - +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task name | Identify the name of this monitoring. The name needs to be unique | +| Service Port | The port that the TiDB database provides externally for status reporting is 10080 by default | +| PD Port | The PD port for the TiDB database, which defaults to 2379 | +| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms | +| JDBC Port | The TiDB database externally provides the port used for client requests, which defaults to 4000 | +| Database name | Database instance name, optional | +| Username | Database connection user name, optional | +| Password | Database connection password, optional | +| JDBC URL | Database using [JDBC](https://docs.pingcap.com/tidb/stable/dev-guide-connect-to-tidb#jdbc) connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | ### Collection Metric @@ -44,12 +43,13 @@ Due to the large number of metrics that can be monitored, only the metrics queri #### Metric set: global variables -| Metric Name | Metric Unit | Metric Help Description | -|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| version | none | The MySQL version, followed by the TiDB version. For example '8.0.11-TiDB-v7.5.1'. | -| version_comment | none | The TiDB version. For example, 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible'. | -| version_compile_machine | none | The name of the CPU architecture on which TiDB is running. | -| version_compile_os | none | The name of the OS on which TiDB is running. | -| max_connections | none | The maximum number of concurrent connections permitted for a single TiDB instance. This variable can be used for resources control. The default value 0 means no limit. When the value of this variable is larger than 0, and the number of connections reaches the value, the TiDB server rejects new connections from clients. | -| datadir | none | The location where data is stored. This location can be a local path /tmp/tidb, or point to a PD server if the data is stored on TiKV. A value in the format of ${pd-ip}:${pd-port} indicates the PD server that TiDB connects to on startup. | -| port | none | The port that the tidb-server is listening on when speaking the MySQL protocol. | +| Metric Name | Metric Unit | Metric Help Description | +|-------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| version | none | The MySQL version, followed by the TiDB version. For example '8.0.11-TiDB-v7.5.1'. | +| version_comment | none | The TiDB version. For example, 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible'. | +| version_compile_machine | none | The name of the CPU architecture on which TiDB is running. | +| version_compile_os | none | The name of the OS on which TiDB is running. | +| max_connections | none | The maximum number of concurrent connections permitted for a single TiDB instance. This variable can be used for resources control. The default value 0 means no limit. When the value of this variable is larger than 0, and the number of connections reaches the value, the TiDB server rejects new connections from clients. | +| datadir | none | The location where data is stored. This location can be a local path /tmp/tidb, or point to a PD server if the data is stored on TiKV. A value in the format of ${pd-ip}:${pd-port} indicates the PD server that TiDB connects to on startup. | +| port | none | The port that the tidb-server is listening on when speaking the MySQL protocol. | + diff --git a/home/versioned_docs/version-v1.5.x/help/time_expression.md b/home/versioned_docs/version-v1.5.x/help/time_expression.md index e2cb0928b05..482fc04cc05 100644 --- a/home/versioned_docs/version-v1.5.x/help/time_expression.md +++ b/home/versioned_docs/version-v1.5.x/help/time_expression.md @@ -23,28 +23,28 @@ ${FORMATTER [{ + | - } ]} > Example outputs are based on the current time being `2022-04-24 02:40:00.123` -| Name | Description | Example | -|---------------|------------------------------------|------------------------| -| @now | Formats as `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | -| @date | Formats as `yyyy-MM-dd` | 2022-04-24 | -| @timestamp10 | Returns 10-digit timestamp | 1650768000 | -| @timestamp | Returns 13-digit timestamp | 1650768000000 | -| @time | Formats as `HH:mm:ss` | 02:40:00 | -| @year | Formats as `yyyy` | 2022 | -| @month | Formats as `MM` | 04 | -| @day | Formats as `dd` | 24 | -| @hour | Formats as `HH` | 02 | -| @minute | Formats as `mm` | 40 | -| @millisecond | Formats as `SSS` | 123 | -| @second | Formats as `ss` | 00 | +| Name | Description | Example | +|--------------|----------------------------------|---------------------| +| @now | Formats as `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | +| @date | Formats as `yyyy-MM-dd` | 2022-04-24 | +| @timestamp10 | Returns 10-digit timestamp | 1650768000 | +| @timestamp | Returns 13-digit timestamp | 1650768000000 | +| @time | Formats as `HH:mm:ss` | 02:40:00 | +| @year | Formats as `yyyy` | 2022 | +| @month | Formats as `MM` | 04 | +| @day | Formats as `dd` | 24 | +| @hour | Formats as `HH` | 02 | +| @minute | Formats as `mm` | 40 | +| @millisecond | Formats as `SSS` | 123 | +| @second | Formats as `ss` | 00 | ### Supported Time Units | Name | Description | |------|-------------| -| y | Year | +| y | Year | | M | Month | -| d | Day | +| d | Day | | H | Hour | | m | Minute | | s | Second | @@ -57,8 +57,9 @@ ${FORMATTER [{ + | - } ]} #### Usage Examples 1. Simple expression - - `${now}` gets the current time and formats it as `yyyy-MM-dd HH:mm:ss` - - `${time+1h}` calculates the time one hour from now and formats it as `HH:mm:ss` - - `${time+1h+15s+30s}` calculates the time one hour, 15 minutes, and 30 seconds from now and formats it as `HH:mm:ss` + - `${now}` gets the current time and formats it as `yyyy-MM-dd HH:mm:ss` + - `${time+1h}` calculates the time one hour from now and formats it as `HH:mm:ss` + - `${time+1h+15s+30s}` calculates the time one hour, 15 minutes, and 30 seconds from now and formats it as `HH:mm:ss` 2. Complex expression template (if the built-in formatter does not meet your needs, you can combine multiple expressions) - - `${@year}年${@month}月${@day}日` returns the current date formatted as yyyy年MM月dd日 + - `${@year}年${@month}月${@day}日` returns the current date formatted as yyyy年MM月dd日 + diff --git a/home/versioned_docs/version-v1.5.x/help/tomcat.md b/home/versioned_docs/version-v1.5.x/help/tomcat.md index 8b35808ffc8..60591f85579 100644 --- a/home/versioned_docs/version-v1.5.x/help/tomcat.md +++ b/home/versioned_docs/version-v1.5.x/help/tomcat.md @@ -11,61 +11,60 @@ keywords: [open source monitoring tool, open source tomcat monitoring tool, moni ### 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 | +| 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 | +| 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 | +| 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 | - +| 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 | +| 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 +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 diff --git a/home/versioned_docs/version-v1.5.x/help/ubuntu.md b/home/versioned_docs/version-v1.5.x/help/ubuntu.md index e7d368c9ea3..8d3b65ce195 100644 --- a/home/versioned_docs/version-v1.5.x/help/ubuntu.md +++ b/home/versioned_docs/version-v1.5.x/help/ubuntu.md @@ -9,74 +9,74 @@ keywords: [open source monitoring tool, open source linux ubuntu monitoring tool ### 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 | +| 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 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 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 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 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 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 | +| 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.5.x/help/udp_port.md b/home/versioned_docs/version-v1.5.x/help/udp_port.md index 7fdcce3cf77..51c3098dc9a 100644 --- a/home/versioned_docs/version-v1.5.x/help/udp_port.md +++ b/home/versioned_docs/version-v1.5.x/help/udp_port.md @@ -10,7 +10,7 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito ### Configuration parameter -| Parameter name | Parameter help description | +| 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. | @@ -26,9 +26,7 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito #### Metric set：summary -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |---------------|-------------------|-------------------------| | Response Time | Milliseconds (ms) | Website response time | - - diff --git a/home/versioned_docs/version-v1.5.x/help/website.md b/home/versioned_docs/version-v1.5.x/help/website.md index e227de0dd1f..afe86397c9e 100644 --- a/home/versioned_docs/version-v1.5.x/help/website.md +++ b/home/versioned_docs/version-v1.5.x/help/website.md @@ -5,25 +5,26 @@ 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. +> Monitor whether the website is available, response time and other Metrics. -### Configuration parameter +### 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 | +| 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 +### Collection Metric -#### Metric set：summary +#### Metric set：summary + +| Metric name | Metric unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | ms | Website response time | -| Metric name | Metric unit | Metric help description | -| ----------- | ----------- | ----------- | -| responseTime | ms | Website response time | diff --git a/home/versioned_docs/version-v1.5.x/help/websocket.md b/home/versioned_docs/version-v1.5.x/help/websocket.md index 8e3d29a204a..13d1f6eed31 100644 --- a/home/versioned_docs/version-v1.5.x/help/websocket.md +++ b/home/versioned_docs/version-v1.5.x/help/websocket.md @@ -9,7 +9,7 @@ keywords: [ open source monitoring tool, Websocket监控 ] ### Configuration parameter -| Parameter name | Parameter help description | +| Parameter name | Parameter help description | |---------------------------|--------------------------------------------------------------------------------------------------------------------------| | Host of WebSocket service | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | @@ -23,7 +23,7 @@ keywords: [ open source monitoring tool, Websocket监控 ] #### Metric set：Summary -| Metric name | Metric unit | Metric help description | +| Metric name | Metric unit | Metric help description | |---------------|-------------|-------------------------| | responseTime | ms | Response time | | httpVersion | none | HTTP version | @@ -31,3 +31,4 @@ keywords: [ open source monitoring tool, Websocket监控 ] | statusMessage | none | Status messages | | connection | none | Connect type | | upgrade | none | Upgraded protocols | + diff --git a/home/versioned_docs/version-v1.5.x/help/windows.md b/home/versioned_docs/version-v1.5.x/help/windows.md index 82e36d23470..e4be2bd6d96 100644 --- a/home/versioned_docs/version-v1.5.x/help/windows.md +++ b/home/versioned_docs/version-v1.5.x/help/windows.md @@ -6,38 +6,39 @@ keywords: [open source monitoring tool, open source windows monitoring tool, mon --- > Collect and monitor the general performance Metrics of Windows operating system through SNMP protocol. -> Note⚠️ You need to start SNMP service for Windows server. +> 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) +[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 | +| 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 | +| 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 | +| 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.5.x/help/yarn.md b/home/versioned_docs/version-v1.5.x/help/yarn.md index 176a3209fee..d7f304ff910 100644 --- a/home/versioned_docs/version-v1.5.x/help/yarn.md +++ b/home/versioned_docs/version-v1.5.x/help/yarn.md @@ -15,69 +15,70 @@ Retrieve the HTTP monitoring port of Apache Yarn. Value: `yarn.resourcemanager.w ## Configuration Parameters -| Parameter Name | Parameter Description | -| ---------------- |----------------------------------------------------| -| Target Host | IP address, IPV6, or domain name of the monitored endpoint. Without protocol header. | -| Port | Monitoring port number of Apache Yarn, default is 8088. | -| Query Timeout | Timeout for querying Apache Yarn, in milliseconds, default is 6000 milliseconds. | +| Parameter Name | Parameter Description | +|------------------|-------------------------------------------------------------------------------------------| +| Target Host | IP address, IPV6, or domain name of the monitored endpoint. Without protocol header. | +| Port | Monitoring port number of Apache Yarn, default is 8088. | +| Query Timeout | Timeout for querying Apache Yarn, in milliseconds, default is 6000 milliseconds. | | Metrics Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. | ### Collected Metrics #### Metric Set: ClusterMetrics -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | -----------------------------------------| -| NumActiveNMs | | Number of currently active NodeManagers | -| NumDecommissionedNMs | | Number of currently decommissioned NodeManagers | -| NumDecommissioningNMs | | Number of nodes currently decommissioning | -| NumLostNMs | | Number of lost nodes in the cluster | -| NumUnhealthyNMs | | Number of unhealthy nodes in the cluster | +| Metric Name | Unit | Metric Description | +|-----------------------|------|-------------------------------------------------| +| NumActiveNMs | | Number of currently active NodeManagers | +| NumDecommissionedNMs | | Number of currently decommissioned NodeManagers | +| NumDecommissioningNMs | | Number of nodes currently decommissioning | +| NumLostNMs | | Number of lost nodes in the cluster | +| NumUnhealthyNMs | | Number of unhealthy nodes in the cluster | #### Metric Set: JvmMetrics -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | -------------------------------------------- | -| MemNonHeapCommittedM | MB | Current committed size of non-heap memory in JVM | -| MemNonHeapMaxM | MB | Maximum available non-heap memory in JVM | -| MemNonHeapUsedM | MB | Current used size of non-heap memory in JVM | -| MemHeapCommittedM | MB | Current committed size of heap memory in JVM | -| MemHeapMaxM | MB | Maximum available heap memory in JVM | -| MemHeapUsedM | MB | Current used size of heap memory in JVM | -| GcTimeMillis | | JVM GC time | -| GcCount | | Number of JVM GC occurrences | +| Metric Name | Unit | Metric Description | +|----------------------|------|--------------------------------------------------| +| MemNonHeapCommittedM | MB | Current committed size of non-heap memory in JVM | +| MemNonHeapMaxM | MB | Maximum available non-heap memory in JVM | +| MemNonHeapUsedM | MB | Current used size of non-heap memory in JVM | +| MemHeapCommittedM | MB | Current committed size of heap memory in JVM | +| MemHeapMaxM | MB | Maximum available heap memory in JVM | +| MemHeapUsedM | MB | Current used size of heap memory in JVM | +| GcTimeMillis | | JVM GC time | +| GcCount | | Number of JVM GC occurrences | #### Metric Set: QueueMetrics -| Metric Name | Unit | Metric Description | -| --------------------------- | ---- | -------------------------------------------- | -| queue | | Queue name | -| AllocatedVCores | | Allocated virtual cores (allocated) | -| ReservedVCores | | Reserved cores | -| AvailableVCores | | Available cores (unallocated) | -| PendingVCores | | Blocked scheduling cores | -| AllocatedMB | MB | Allocated (used) memory size | -| AvailableMB | MB | Available memory (unallocated) | -| PendingMB | MB | Blocked scheduling memory | -| ReservedMB | MB | Reserved memory | -| AllocatedContainers | | Number of allocated (used) containers | -| PendingContainers | | Number of blocked scheduling containers | -| ReservedContainers | | Number of reserved containers | -| AggregateContainersAllocated| | Total aggregated containers allocated | -| AggregateContainersReleased| | Total aggregated containers released | -| AppsCompleted | | Number of completed applications | -| AppsKilled | | Number of killed applications | -| AppsFailed | | Number of failed applications | -| AppsPending | | Number of pending applications | -| AppsRunning | | Number of currently running applications | -| AppsSubmitted | | Number of submitted applications | -| running_0 | | Number of jobs running for less than 60 minutes | -| running_60 | | Number of jobs running between 60 and 300 minutes | -| running_300 | | Number of jobs running between 300 and 1440 minutes | -| running_1440 | | Number of jobs running for more than 1440 minutes | +| Metric Name | Unit | Metric Description | +|------------------------------|------|-----------------------------------------------------| +| queue | | Queue name | +| AllocatedVCores | | Allocated virtual cores (allocated) | +| ReservedVCores | | Reserved cores | +| AvailableVCores | | Available cores (unallocated) | +| PendingVCores | | Blocked scheduling cores | +| AllocatedMB | MB | Allocated (used) memory size | +| AvailableMB | MB | Available memory (unallocated) | +| PendingMB | MB | Blocked scheduling memory | +| ReservedMB | MB | Reserved memory | +| AllocatedContainers | | Number of allocated (used) containers | +| PendingContainers | | Number of blocked scheduling containers | +| ReservedContainers | | Number of reserved containers | +| AggregateContainersAllocated | | Total aggregated containers allocated | +| AggregateContainersReleased | | Total aggregated containers released | +| AppsCompleted | | Number of completed applications | +| AppsKilled | | Number of killed applications | +| AppsFailed | | Number of failed applications | +| AppsPending | | Number of pending applications | +| AppsRunning | | Number of currently running applications | +| AppsSubmitted | | Number of submitted applications | +| running_0 | | Number of jobs running for less than 60 minutes | +| running_60 | | Number of jobs running between 60 and 300 minutes | +| running_300 | | Number of jobs running between 300 and 1440 minutes | +| running_1440 | | Number of jobs running for more than 1440 minutes | #### Metric Set: runtime -| Metric Name | Unit | Metric Description | -| ----------------------- | ---- | --------------------------| -| StartTime | | Startup timestamp | \ No newline at end of file +| Metric Name | Unit | Metric Description | +|-------------|------|--------------------| +| StartTime | | Startup timestamp | + diff --git a/home/versioned_docs/version-v1.5.x/help/zookeeper.md b/home/versioned_docs/version-v1.5.x/help/zookeeper.md index b7a34f49eda..f14b0bb8273 100644 --- a/home/versioned_docs/version-v1.5.x/help/zookeeper.md +++ b/home/versioned_docs/version-v1.5.x/help/zookeeper.md @@ -10,10 +10,12 @@ keywords: [open source monitoring tool, open source zookeeper monitoring tool, m ### 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. + +> 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 @@ -28,73 +30,74 @@ Steps > 3.Restart service -```shell +```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 -``` +> +> ```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 | +| 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 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 | - +| 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.5.x/introduce.md b/home/versioned_docs/version-v1.5.x/introduce.md index 98305d95ed5..b1dd5bc6771 100644 --- a/home/versioned_docs/version-v1.5.x/introduce.md +++ b/home/versioned_docs/version-v1.5.x/introduce.md @@ -5,7 +5,7 @@ sidebar_label: Introduce slug: / --- -> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. +> 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/) @@ -32,11 +32,9 @@ slug: / * 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. -> 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. @@ -49,7 +47,6 @@ Do you believe that users can just write a monitoring template on the UI page, c ![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**. @@ -97,7 +94,7 @@ Do you believe that users can just write a monitoring template on the UI page, c > 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. +> 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) @@ -105,12 +102,12 @@ Do you believe that users can just write a monitoring template on the UI page, c > 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 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`. +The principle of `HertzBeat` is to use different protocols to connect directly to the end system, and use the `PULL` form to pull the collected data, without the need for the user to deploy and install `Agent` | `Exporter` on the host of the end, etc. For example, monitoring the `linux operating system`. - For example, if you want to monitor `linux OS`, you can just input the IP port account password or key on `HertzBeat` side. -- For example, to monitor `linux OS`, just enter your ip/port account password or key in `HertzBeat`. +- For example, 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**. @@ -129,7 +126,7 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > Two locations, three centers, multi-cloud environments, multi-isolated networks, you may have heard of these scenarios. When there is a need for a unified monitoring system to monitor the IT resources of different isolated networks, this is where our Cloud Edge Collaboration comes in. In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance. -`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` 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) @@ -148,12 +145,11 @@ In an isolated network where multiple networks are not connected, we need to dep - Built on `Java+SpringBoot+TypeScript+Angular` mainstream technology stack , convenient secondary development . - Open source is not the same as free, dev based on HertzBeat must retain page footnotes, copyright, etc. - **HertzBeat has been included in the [CNCF Observability And Analysis - Monitoring Landscape](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category)** ![cncf](/img/home/cncf-landscape-left-logo.svg) ------ +--- **HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.** @@ -271,7 +267,6 @@ Built-in support for monitoring types include: ![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. @@ -303,7 +298,6 @@ Built-in support for monitoring types include: ![hertzbeat](/img/home/9.png) - ----- **There's so much more to discover. Have Fun!** diff --git a/home/versioned_docs/version-v1.5.x/others/design.md b/home/versioned_docs/version-v1.5.x/others/design.md index e7f80d164d7..da5ec8fffee 100644 --- a/home/versioned_docs/version-v1.5.x/others/design.md +++ b/home/versioned_docs/version-v1.5.x/others/design.md @@ -1,9 +1,9 @@ --- id: design title: 设计文档 -sidebar_label: 设计文档 +sidebar_label: 设计文档 --- -### HertzBeat Arch +### HertzBeat Arch -![architecture](/img/docs/hertzbeat-arch.svg) +![architecture](/img/docs/hertzbeat-arch.svg) diff --git a/home/versioned_docs/version-v1.5.x/others/resource.md b/home/versioned_docs/version-v1.5.x/others/resource.md index 79c16b4ab56..83188bd1c8e 100644 --- a/home/versioned_docs/version-v1.5.x/others/resource.md +++ b/home/versioned_docs/version-v1.5.x/others/resource.md @@ -1,19 +1,19 @@ --- id: resource title: Related resources -sidebar_label: Related resources +sidebar_label: Related resources --- -## Icon Resources +## Icon Resources -### HertzBeat Logo +### HertzBeat Logo -![logo](/img/hertzbeat-logo.svg) +![logo](/img/hertzbeat-logo.svg) -Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) +Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) -### HertzBeat Brand Logo +### HertzBeat Brand Logo -![logo](/img/hertzbeat-brand.svg) +![logo](/img/hertzbeat-brand.svg) -Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) +Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) diff --git a/home/versioned_docs/version-v1.5.x/start/account-modify.md b/home/versioned_docs/version-v1.5.x/start/account-modify.md index 64bba7d72df..8dc8b03a565 100644 --- a/home/versioned_docs/version-v1.5.x/start/account-modify.md +++ b/home/versioned_docs/version-v1.5.x/start/account-modify.md @@ -1,7 +1,7 @@ --- id: account-modify title: Modify Account Username Password And Secret -sidebar_label: Update Account Secret +sidebar_label: Update Account Secret --- ## Update Account @@ -112,12 +112,11 @@ account: role: [guest] ``` -## Update Security Secret +## Update Security Secret -> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. +> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. - -Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. +Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. ```yaml sureness: @@ -128,4 +127,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**Restart HertzBeat, access http://ip:1157/ to explore** +**Restart HertzBeat, access http://ip:1157/ to explore** diff --git a/home/versioned_docs/version-v1.5.x/start/custom-config.md b/home/versioned_docs/version-v1.5.x/start/custom-config.md index 5a60d6b02b9..7554498bc6e 100644 --- a/home/versioned_docs/version-v1.5.x/start/custom-config.md +++ b/home/versioned_docs/version-v1.5.x/start/custom-config.md @@ -1,7 +1,7 @@ --- id: custom-config title: Advanced Params Config -sidebar_label: 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. @@ -12,13 +12,14 @@ This describes how to configure the SMS server, the number of built-in availabil 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` +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) +Add the following Tencent platform SMS server configuration in `application.yml` (parameters need to be replaced with your SMS server configuration) + ```yaml common: sms: @@ -32,7 +33,6 @@ common: 2. Configure alarm custom parameters - ```yaml alerter: # Custom console address @@ -44,6 +44,7 @@ alerter: > 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: @@ -56,3 +57,4 @@ warehouse: port: 6379 password: 123456 ``` + diff --git a/home/versioned_docs/version-v1.5.x/start/docker-deploy.md b/home/versioned_docs/version-v1.5.x/start/docker-deploy.md index 7671366e9ad..10ecb09b001 100644 --- a/home/versioned_docs/version-v1.5.x/start/docker-deploy.md +++ b/home/versioned_docs/version-v1.5.x/start/docker-deploy.md @@ -1,52 +1,51 @@ --- id: docker-deploy title: Install HertzBeat via Docker -sidebar_label: Install via Docker +sidebar_label: Install via Docker --- > Recommend to use docker deploy Apache HertzBeat (incubating) - 1. Download and install the Docker environment Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 After the installation you can check if the Docker version normally output at the terminal. + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` - 2. pull HertzBeat Docker mirror you can look up the mirror version TAG in [dockerhub mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) - or in [quay.io mirror repository](https://quay.io/repository/apache/hertzbeat) + or in [quay.io mirror repository](https://quay.io/repository/apache/hertzbeat) + ```shell $ docker pull apache/hertzbeat $ docker pull apache/hertzbeat-collector ``` - or + + or + ```shell $ docker pull quay.io/tancloud/hertzbeat $ docker pull quay.io/tancloud/hertzbeat-collector ``` - 3. Mounted HertzBeat configuration file (optional) Download and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` Download from [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - You can modify the configuration yml file according to your needs. - - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` - - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) - - **Recommended** If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) - - **Recommended** If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) - + You can modify the configuration yml file according to your needs. + - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` + - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) + - **Recommended** If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) + - **Recommended** If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) 4. Mounted the account file(optional) HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` If you need update account or password, configure `sureness.yml`. Ignore this step without this demand. Download and config `sureness.yml` in the host directory，eg:`$(pwd)/sureness.yml` Download from [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) - For detail steps, please refer to [Configure Account Password](account-modify) - -5. Start the HertzBeat Docker container + For detail steps, please refer to [Configure Account Password](account-modify) +5. Start the HertzBeat Docker container -```shell +```shell $ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=en_US.UTF-8 \ -e TZ=Asia/Shanghai \ @@ -57,25 +56,25 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ --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.** +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 +6. Begin to explore HertzBeat - Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 7. Deploy collector cluster (Optional) -```shell +```shell $ docker run -d \ -e IDENTITY=custom-collector-name \ -e MODE=public \ @@ -84,53 +83,61 @@ $ docker run -d \ --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.** +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. +8. Access `http://localhost:1157` and you will see the registered new collector in dashboard. -**HAVE FUN** +**HAVE FUN** -### FAQ +### 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. + 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 .....` +> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy，visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issues： + 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** +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. +> 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** -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. +> 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) +> 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 -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. +> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. 7. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] + > Please check if the configuration parameters are correct > Is iot-db or td-engine enable set to true > Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed > You can check the startup logs according to the logs directory + diff --git a/home/versioned_docs/version-v1.5.x/start/greptime-init.md b/home/versioned_docs/version-v1.5.x/start/greptime-init.md index cfb148ecea7..84916590868 100644 --- a/home/versioned_docs/version-v1.5.x/start/greptime-init.md +++ b/home/versioned_docs/version-v1.5.x/start/greptime-init.md @@ -8,22 +8,25 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie > It is recommended to use VictoriaMetrics as metrics storage. -GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. +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.** +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** + +### Install GreptimeDB via Docker -### 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 +> 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 \ @@ -33,10 +36,11 @@ $ docker run -p 4000-4004:4000-4004 \ --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 +`-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) diff --git a/home/versioned_docs/version-v1.5.x/start/influxdb-init.md b/home/versioned_docs/version-v1.5.x/start/influxdb-init.md index b752fc82a21..b9eeb2fd00c 100644 --- a/home/versioned_docs/version-v1.5.x/start/influxdb-init.md +++ b/home/versioned_docs/version-v1.5.x/start/influxdb-init.md @@ -1,51 +1,54 @@ --- id: influxdb-init title: Use Time Series Database InfluxDB to Store Metrics Data (Optional) -sidebar_label: Use InfluxDB Store Metrics +sidebar_label: Use InfluxDB Store Metrics --- Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) > It is recommended to use VictoriaMetrics as metrics storage. - **Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance** **⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** -Note⚠️ Need InfluxDB 1.x Version. +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. +> +> 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 +### 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. 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. + Replace `warehouse.store.influxdb` data source parameters, URL account and password. ```yaml warehouse: @@ -70,3 +73,4 @@ warehouse: 1. Do both the time series databases InfluxDB, IoTDB and TDengine need to be configured? Can they both be used? > You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. + diff --git a/home/versioned_docs/version-v1.5.x/start/iotdb-init.md b/home/versioned_docs/version-v1.5.x/start/iotdb-init.md index ee7a66a87f4..43fb3235406 100644 --- a/home/versioned_docs/version-v1.5.x/start/iotdb-init.md +++ b/home/versioned_docs/version-v1.5.x/start/iotdb-init.md @@ -3,6 +3,7 @@ id: iotdb-init title: Use Time Series Database IoTDB to Store Metrics Data (Optional) sidebar_label: Use IoTDB Store Metrics --- + Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) > It is recommended to use VictoriaMetrics as metrics storage. @@ -87,9 +88,8 @@ warehouse: Configuration parameters: - -| Parameter Name | Description | -| ------------------- |-------------------------------------------------------------------------------------------| +| Parameter Name | Description | +|---------------------|-------------------------------------------------------------------------------------------| | enabled | Whether to enable | | host | IoTDB database address | | rpc-port | IoTDB database port | @@ -120,3 +120,4 @@ Configuration parameters: > Is td-engine enable set to true > Note⚠️If both hertzbeat and TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed > You can check the startup logs according to the logs directory + diff --git a/home/versioned_docs/version-v1.5.x/start/mysql-change.md b/home/versioned_docs/version-v1.5.x/start/mysql-change.md index 1095f538b0c..e0f3721bb7f 100644 --- a/home/versioned_docs/version-v1.5.x/start/mysql-change.md +++ b/home/versioned_docs/version-v1.5.x/start/mysql-change.md @@ -1,21 +1,25 @@ --- id: mysql-change title: Use MYSQL Replace H2 Database to Store Metadata(Optional) -sidebar_label: Use MYSQL Instead of H2 +sidebar_label: Use MYSQL Instead of H2 --- -MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. -> If you have the MYSQL environment, can be directly to database creation step. +MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. + +> If you have the MYSQL environment, can be directly to database creation step. + +### Install MYSQL via Docker -### Install MYSQL via Docker 1. Download and install the Docker environment For Docker installation, please refer to the [Docker official documentation](https://docs.docker.com/get-docker/). After the installation, please verify in the terminal that the Docker version can be printed normally. + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. Install MYSQl with Docker +2. Install MYSQl with Docker + ``` $ docker run -d --name mysql \ -p 3306:3306 \ @@ -24,18 +28,20 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data --restart=always \ mysql:5.7 ``` + `-v /opt/data:/var/lib/mysql` is local persistent mount of mysql data directory. `/opt/data` should be replaced with the actual local directory. use ```$ docker ps``` to check if the database started successfully -### Database creation +### Database creation + 1. Enter MYSQL or use the client to connect MYSQL service - `mysql -uroot -p123456` + `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 +### Modify hertzbeat's configuration file application.yml and switch data source - Configure HertzBeat's configuration file Modify `hertzbeat/config/application.yml` configuration file @@ -43,6 +49,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data Replace `spring.database` data source parameters, URL account and password. For example: + ```yaml spring: datasource: @@ -51,7 +58,9 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data 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: + + Specific replacement parameters are as follows and you need to configure account according to the mysql environment: + ```yaml spring: datasource: @@ -63,7 +72,6 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data jpa: database: mysql ``` +- It is recommended to set the host field in the MySQL URL or Redis URL to the public IP address when using Hertzbeat in docker. -- It is recommended to set the host field in the MySQL URL or Redis URL to the public IP address when using Hertzbeat in docker. - -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/start/package-deploy.md b/home/versioned_docs/version-v1.5.x/start/package-deploy.md index 050121f5c55..cbd42ad5bb9 100644 --- a/home/versioned_docs/version-v1.5.x/start/package-deploy.md +++ b/home/versioned_docs/version-v1.5.x/start/package-deploy.md @@ -9,14 +9,15 @@ sidebar_label: Install via Package 1. Download HertzBeat installation package Download installation package `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` corresponding to your system environment - [Download Page](/docs/download) - 2. Configure HertzBeat's configuration file(optional) - Unzip the installation package to the host eg: /opt/hertzbeat - ``` + 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) @@ -27,22 +28,23 @@ sidebar_label: Install via Package 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) + 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. - ``` + Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. + + ``` $ ./startup.sh ``` +5. Begin to explore HertzBeat -5. Begin to explore HertzBeat - - Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 6. Deploy collector clusters (Optional) - - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](/docs/download) + - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](/docs/download) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` + ```yaml collector: dispatch: @@ -59,7 +61,7 @@ sidebar_label: Install via Package **HAVE FUN** -### FAQ +### FAQ 1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance** @@ -67,6 +69,7 @@ sidebar_label: Install via Package requirement：JDK17 ENV download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) After installation use command line to check whether you install it successfully. + ``` $ java -version java version "17.0.9" @@ -74,18 +77,20 @@ sidebar_label: Install via Package Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) ``` - 2. **According to the process deploy，visit http://ip:1157/ no interface** 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. +> 2：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. 4. **Monitoring historical charts with no data for a long time ** + > 1: Whether the time series database is configured or not, if it is not configured, there is no historical chart data. > 2: If you are using Tdengine, check whether the database `hertzbeat` of Tdengine is created. > 3: HertzBeat's configuration file `application.yml`, the dependent services in it, the time series, the IP account password, etc. are configured correctly. diff --git a/home/versioned_docs/version-v1.5.x/start/postgresql-change.md b/home/versioned_docs/version-v1.5.x/start/postgresql-change.md index c78a24a1ca7..ac63a41ebc9 100644 --- a/home/versioned_docs/version-v1.5.x/start/postgresql-change.md +++ b/home/versioned_docs/version-v1.5.x/start/postgresql-change.md @@ -3,27 +3,35 @@ id: postgresql-change title: Use PostgreSQL Replace H2 Database to Store Metadata(Optional) sidebar_label: Use PostgreSQL Instead of H2 --- + PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information. > If you have the PostgreSQL environment, can be directly to database creation step. ### Install PostgreSQL via Docker + 1. Download and install the Docker environment Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 After the installation you can check if the Docker version normally output at the terminal. + ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` 2. Install PostgreSQL with Docker + ``` $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` + use```$ docker ps```to check if the database started successfully + 3. Create database in container manually or with [script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-iotdb/conf/sql/schema.sql). ### Database creation -1. Enter postgreSQL or use the client to connect postgreSQL service + +1. Enter postgreSQL or use the client to connect postgreSQL service + ``` su - postgres psql @@ -39,6 +47,7 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition 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: @@ -47,7 +56,9 @@ spring: 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: @@ -70,4 +81,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/start/quickstart.md b/home/versioned_docs/version-v1.5.x/start/quickstart.md index 5bd804c4d54..2e10d8f72de 100644 --- a/home/versioned_docs/version-v1.5.x/start/quickstart.md +++ b/home/versioned_docs/version-v1.5.x/start/quickstart.md @@ -1,7 +1,7 @@ --- id: quickstart title: Quick Start -sidebar_label: Quick Start +sidebar_label: Quick Start --- ### 🐕 Quick Start @@ -29,6 +29,7 @@ sidebar_label: Quick Start ``` 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. @@ -45,6 +46,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache 5. Deploy collector clusters(Optional) - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [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: @@ -68,9 +70,9 @@ Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apach 3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. 4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` -Detailed steps refer to [CONTRIBUTING](../community/contribution) +Detailed steps refer to [CONTRIBUTING](../community/contribution) -##### 4：Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose +##### 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). @@ -82,4 +84,4 @@ 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** +**HAVE FUN** diff --git a/home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md b/home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md index 57f537aa4ac..ef2c581d57d 100644 --- a/home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md +++ b/home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md @@ -1,7 +1,7 @@ --- id: rainbond-deploy title: Use Rainbond Deploy HertzBeat -sidebar_label: Install via Rainbond +sidebar_label: Install via Rainbond --- If you are unfamiliar with Kubernetes, and want to install Apache HertzBeat (incubating) in Kubernetes, you can use Rainbond to deploy. Rainbond is a cloud-native application management platform built on Kubernetes and simplifies the application deployment to Kubernetes. diff --git a/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md b/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md index d8c06a8beba..26c7f6ecf32 100644 --- a/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md +++ b/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md @@ -12,7 +12,6 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v Apache HertzBeat (incubating) is a real-time monitoring tool with powerful custom monitoring capabilities without Agent. Website monitoring, PING connectivity, port availability, database, operating system, middleware, API monitoring, threshold alarms, alarm notification (email, WeChat, Ding Ding Feishu). - github: https://github.com/apache/hertzbeat #### Install HertzBeat @@ -29,7 +28,6 @@ github: https://github.com/apache/hertzbeat > System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate - ![](/img/docs/start/ssl_1.png) 2. Configure the monitoring website @@ -43,48 +41,38 @@ github: https://github.com/apache/hertzbeat > 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 @@ -93,7 +81,6 @@ https://hertzbeat.apache.org/docs/help/alert_dingtalk > 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. diff --git a/home/versioned_docs/version-v1.5.x/start/tdengine-init.md b/home/versioned_docs/version-v1.5.x/start/tdengine-init.md index 1f73a4151eb..4048520bfe2 100644 --- a/home/versioned_docs/version-v1.5.x/start/tdengine-init.md +++ b/home/versioned_docs/version-v1.5.x/start/tdengine-init.md @@ -1,85 +1,90 @@ --- id: tdengine-init title: Use Time Series Database TDengine to Store Metrics Data (Optional) -sidebar_label: Use TDengine Store Metrics +sidebar_label: Use TDengine Store Metrics --- Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) > It is recommended to use VictoriaMetrics as metrics storage. -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. +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. +Note⚠️ Need TDengine 3.x Version. -> If you have TDengine environment, can directly skip to create a database instance. +> If you have TDengine environment, can directly skip to create a database instance. +### Install TDengine via Docker -### 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. 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 -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: - + 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 - + + 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 - +3. Check if hertzbeat database has been created success + ``` taos> show databases; taos> use hertzbeat; ``` -**Note⚠️If you install TDengine using package** +**Note⚠️If you install TDengine using package** > In addition to start the server，you must execute `systemctl start taosadapter` to start adapter -### Configure the database connection in hertzbeat `application.yml` configuration file +### Configure the database connection in hertzbeat `application.yml` configuration file 1. Configure HertzBeat's configuration file Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.td-engine` data source parameters, URL account and password. + Replace `warehouse.store.td-engine` data source parameters, URL account and password. ```yaml warehouse: @@ -101,16 +106,21 @@ warehouse: ### 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. +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 +> You can check the startup logs according to the logs directory + diff --git a/home/versioned_docs/version-v1.5.x/start/upgrade.md b/home/versioned_docs/version-v1.5.x/start/upgrade.md index f34f3b36d03..f4d9b8ce14e 100644 --- a/home/versioned_docs/version-v1.5.x/start/upgrade.md +++ b/home/versioned_docs/version-v1.5.x/start/upgrade.md @@ -1,7 +1,7 @@ --- id: upgrade title: HertzBeat New Version Upgrade -sidebar_label: Version Upgrade Guide +sidebar_label: Version Upgrade Guide --- **HertzBeat Release Version List** @@ -14,7 +14,6 @@ Apache HertzBeat (incubating)'s metadata information is stored in H2 or Mysql, P **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 @@ -22,30 +21,26 @@ Apache HertzBeat (incubating)'s metadata information is stored in H2 or Mysql, P - `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 +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 +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 +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 +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** +**HAVE FUN** diff --git a/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md b/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md index 327bc4999af..3d0c22901a8 100644 --- a/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md +++ b/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md @@ -1,7 +1,7 @@ --- id: victoria-metrics-init title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended) -sidebar_label: Use VictoriaMetrics Store Metrics(Recommended) +sidebar_label: Use VictoriaMetrics Store Metrics(Recommended) --- Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) @@ -15,17 +15,19 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t > If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step. -### Install VictoriaMetrics via Docker +### 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 +> 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 \ @@ -34,8 +36,8 @@ $ docker run -d -p 8428:8428 \ 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 +`-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 @@ -61,5 +63,7 @@ warehouse: ### FAQ -1. Do both the time series databases need to be configured? Can they both be used? +1. Do both the time series databases need to be configured? Can they both be used? + > You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which can affects the historical chart data. + diff --git a/home/versioned_docs/version-v1.5.x/template.md b/home/versioned_docs/version-v1.5.x/template.md index 4bdf785e588..cee7aa05055 100644 --- a/home/versioned_docs/version-v1.5.x/template.md +++ b/home/versioned_docs/version-v1.5.x/template.md @@ -4,27 +4,27 @@ title: Monitoring Template Here sidebar_label: Monitoring Template --- -> Apache HertzBeat (incubating) is an open source, real-time monitoring tool with custom-monitor and agentLess. - +> Apache HertzBeat (incubating) is an open source, real-time monitoring tool with custom-monitor and agentLess. +> > We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. > Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? -Here is the architecture. +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!** +**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 +### 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)
+ 👉 [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)
@@ -32,7 +32,7 @@ Here is the architecture.  👉 [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 +### 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)
@@ -49,7 +49,7 @@ Here is the architecture.  👉 [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 +### 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)
@@ -64,7 +64,6 @@ Here is the architecture.  👉 [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)
@@ -78,13 +77,12 @@ Here is the architecture.  👉 [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 +### 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)
diff --git a/pom.xml b/pom.xml index c278c98eddf..31f9f010b8f 100644 --- a/pom.xml +++ b/pom.xml @@ -490,7 +490,7 @@ false - home/docs/**/*.md + home/**/*.md From 88b53a564a98e05187c2fa20bff85714956696f0 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 13 Aug 2024 10:36:10 +0800 Subject: [PATCH 3/4] [feature]add markdown formatter --- .../version-v1.4.x/others/developer.md | 440 +++++++++--------- 1 file changed, 221 insertions(+), 219 deletions(-) diff --git a/home/versioned_docs/version-v1.4.x/others/developer.md b/home/versioned_docs/version-v1.4.x/others/developer.md index 0ceca3e27d8..e8d651af594 100644 --- a/home/versioned_docs/version-v1.4.x/others/developer.md +++ b/home/versioned_docs/version-v1.4.x/others/developer.md @@ -1,6 +1,6 @@ --- -id: developer -title: Contributors +id: developer +title: Contributors sidebar_label: Contributors --- @@ -37,224 +37,226 @@ Thanks to these wonderful people, welcome to join us: [Contributor Guide](contr + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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
📖
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
📖
+ From 5d06b3d326a580e83a71392e7c2a68d12db76ef5 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 13 Aug 2024 10:48:13 +0800 Subject: [PATCH 4/4] [feature]add markdown formatter --- .../version-v1.4.x/others/developer.md | 447 +++++++++--------- 1 file changed, 225 insertions(+), 222 deletions(-) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md index 6398980aa50..0b503032d0f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md @@ -1,7 +1,7 @@ --- -id: developer -title: 开发者们 -sidebar_label: 开发者们 +id: developer +title: 开发者们 +sidebar_label: 开发者们 --- ## ✨ HertzBeat的成员们 @@ -26,7 +26,7 @@ sidebar_label: 开发者们 -cert +cert ## ✨ HertzBeat的开发者们 @@ -37,224 +37,227 @@ Thanks these wonderful people, welcome to join us: [贡献者指南](contributin + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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
📖
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
📖
+ - + +