You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2023/01/13 02:22:31 UTC
[GitHub] [iotdb] SpriCoder commented on a diff in pull request #8853: Add query metrics doc
SpriCoder commented on code in PR #8853:
URL: https://github.com/apache/iotdb/pull/8853#discussion_r1068853040
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -60,19 +62,36 @@ Any person cares about the system's status, including but not limited to RD, QA,
In IoTDB's metric module, each metrics is uniquely identified by `Metric Name` and `Tags`.
- `Metric Name`: Metric type name, such as `logback_events` means log events.
-- `Tags`: indicator classification, in the form of Key-Value pairs, each indicator can have 0 or more categories, common Key-Value pairs:
- - `name = xxx`: The name of the monitored object, which is the description of **business logic**. For example, for a monitoring item of type `Metric Name = entry_seconds_count`, the meaning of name refers to the monitored business interface.
- - `type = xxx`: Monitoring indicator type subdivision, which is a description of **monitoring indicator** itself. For example, for monitoring items of type `Metric Name = point`, the meaning of type refers to the specific type of monitoring points.
- - `status = xxx`: The status of the monitored object is a description of **business logic**. For example, for monitoring items of type `Metric Name = Task`, this parameter can be used to distinguish the status of the monitored object.
- - `user = xxx`: The relevant user of the monitored object is a description of **business logic**. For example, count the total points written by the `root` user.
- - Customize according to the specific situation: For example, there is a level classification under logback_events_total, which is used to indicate the number of logs under a specific level.
-- `Metric Level`: The level of metric managing level, The default startup level is `Core` level, the recommended startup level is `Important level`, and the audit strictness is `Core > Important > Normal > All`
- - `Core`: Core metrics of the system, used by the **operation and maintenance personnel**, which is related to the **performance, stability, and security** of the system, such as the status of the instance, the load of the system, etc.
- - `Important`: Important metrics of the module, which is used by **operation and maintenance and testers**, and is directly related to **the running status of each module**, such as the number of merged files, execution status, etc.
- - `Normal`: Normal metrics of the module, used by **developers** to facilitate **locating the module** when problems occur, such as specific key operation situations in the merger.
- - `All`: All metrics of the module, used by **module developers**, often used when the problem is reproduced, so as to solve the problem quickly.
+- `Tags`: indicator classification, in the form of Key-Value pairs, each indicator can have 0 or more categories, common
+ Key-Value pairs:
+ - `name = xxx`: The name of the monitored object, which is the description of **business logic**. For example, for a
+ monitoring item of type `Metric Name = entry_seconds_count`, the meaning of name refers to the monitored business
+ interface.
+ - `type = xxx`: Monitoring indicator type subdivision, which is a description of **monitoring indicator** itself.
+ For example, for monitoring items of type `Metric Name = point`, the meaning of type refers to the specific type
+ of monitoring points.
+ - `status = xxx`: The status of the monitored object is a description of **business logic**. For example, for
+ monitoring items of type `Metric Name = Task`, this parameter can be used to distinguish the status of the
+ monitored object.
+ - `user = xxx`: The relevant user of the monitored object is a description of **business logic**. For example, count
+ the total points written by the `root` user.
+ - Customize according to the specific situation: For example, there is a level classification under
+ logback_events_total, which is used to indicate the number of logs under a specific level.
+- `Metric Level`: The level of metric managing level, The default startup level is `Core` level, the recommended startup
+ level is `Important level`, and the audit strictness is `Core > Important > Normal > All`
+ - `Core`: Core metrics of the system, used by the **operation and maintenance personnel**, which is related to
+ the **performance, stability, and security** of the system, such as the status of the instance, the load of the
+ system, etc.
+ - `Important`: Important metrics of the module, which is used by **operation and maintenance and testers**, and is
+ directly related to **the running status of each module**, such as the number of merged files, execution status,
+ etc.
+ - `Normal`: Normal metrics of the module, used by **developers** to facilitate **locating the module** when problems
+ occur, such as specific key operation situations in the merger.
Review Comment:
Same problem
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -51,7 +51,9 @@ Belows are some typical application scenarios
running abnormally.
## 2. Who will use metric framework?
-Any person cares about the system's status, including but not limited to RD, QA, SRE, DBA, can use the metrics to work more efficiently.
+
+Any person cares about the system's status, including but not limited to RD, QA, SRE, DBA, can use the metrics to work
+more efficiently.
Review Comment:
Why add blank line here? And why split the sentence into 2 line.
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -87,16 +106,20 @@ If you want to add your own metrics data in IoTDB, please see
the [IoTDB Metric Framework] (https://github.com/apache/iotdb/tree/master/metrics) document.
### 4.1. Core level metrics
-Core-level metrics are enabled by default during system operation. The addition of each Core-level metrics needs to be carefully evaluated. The current Core-level metrics are as follows:
+
+Core-level metrics are enabled by default during system operation. The addition of each Core-level metrics needs to be
+carefully evaluated. The current Core-level metrics are as follows:
Review Comment:
Why add blank line here? And why split the sentence into 2 line.
##########
docs/zh/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -386,20 +484,24 @@ static_configs:
[Grafana从Prometheus查询数据并绘图的文档](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus)
#### 5.2.4. Apache IoTDB Dashboard
+
我们提供了Apache IoTDB Dashboard，在Grafana中显示的效果图如下所示：
##### 5.2.4.1. 如何获取 Apache IoTDB Dashboard？
1. 您可以在 GitHub 上获取到Dashboard的json文件。
- 1. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-ConfigNode-Dashboard.json">Apache IoTDB ConfigNode Dashboard</a>
- 2. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-DataNode-Dashboard.json">Apache IoTDB DataNode Dashboard</a>
+ 1. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-ConfigNode-Dashboard.json">
+ Apache IoTDB ConfigNode Dashboard</a>
+ 2. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-DataNode-Dashboard.json">
+ Apache IoTDB DataNode Dashboard</a>
Review Comment:
Why split into 2 lines
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -397,22 +519,26 @@ The following documents may help you have a good journey with Prometheus and Gra
[Grafana query metrics from Prometheus](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus)
#### 5.2.4. Apache IoTDB Dashboard
+
We provide the Apache IoTDB Dashboard, and the rendering shown in Grafana is as follows:
##### 5.2.4.1. How to get Apache IoTDB Dashboard
1. You can obtain the json files of Dashboards by GitHub:
- 1. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-ConfigNode-Dashboard.json">Apache IoTDB ConfigNode Dashboard</a>
- 2. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-DataNode-Dashboard.json">Apache IoTDB DataNode Dashboard</a>
+ 1. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-ConfigNode-Dashboard.json">
+ Apache IoTDB ConfigNode Dashboard</a>
+ 2. <a href = "https://github.com/apache/iotdb/tree/master/docs/UserGuide/Monitor-Alert/Apache-IoTDB-DataNode-Dashboard.json">
+ Apache IoTDB DataNode Dashboard</a>
Review Comment:
Why split into 2 lines
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -298,15 +411,22 @@ The relevant configuration of the metric module is in `conf/iotdb-{datanode/conf
configuration items support hot loading through the `load configuration` command.
### 5.1. JMX
-For metrics exposed externally using JMX, you can view them through Jconsole. After entering the Jconsole monitoring page, you will first see an overview of various running conditions of IoTDB. Here you can see heap memory information, thread information, class information, and the server's CPU usage.
+
+For metrics exposed externally using JMX, you can view them through Jconsole. After entering the Jconsole monitoring
+page, you will first see an overview of various running conditions of IoTDB. Here you can see heap memory information,
+thread information, class information, and the server's CPU usage.
Review Comment:
Why add blank line here? And why split the sentence into 2 line.
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -298,15 +411,22 @@ The relevant configuration of the metric module is in `conf/iotdb-{datanode/conf
configuration items support hot loading through the `load configuration` command.
### 5.1. JMX
-For metrics exposed externally using JMX, you can view them through Jconsole. After entering the Jconsole monitoring page, you will first see an overview of various running conditions of IoTDB. Here you can see heap memory information, thread information, class information, and the server's CPU usage.
+
+For metrics exposed externally using JMX, you can view them through Jconsole. After entering the Jconsole monitoring
+page, you will first see an overview of various running conditions of IoTDB. Here you can see heap memory information,
+thread information, class information, and the server's CPU usage.
#### 5.1.1. Obtain metric data
-After connecting to JMX, you can find the "MBean" named "org.apache.iotdb.metrics" through the "MBeans" tab, and you can view the specific values of all monitoring metrics in the sidebar.
+
+After connecting to JMX, you can find the "MBean" named "org.apache.iotdb.metrics" through the "MBeans" tab, and you can
+view the specific values of all monitoring metrics in the sidebar.
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" alt="metric-jmx" src="https://user-images.githubusercontent.com/46039728/204018765-6fda9391-ebcf-4c80-98c5-26f34bd74df0.png">
#### 5.1.2. Get other relevant data
-After connecting to JMX, you can find the "MBean" named "org.apache.iotdb.service" through the "MBeans" tab, as shown in the image below, to understand the basic status of the service
+
+After connecting to JMX, you can find the "MBean" named "org.apache.iotdb.service" through the "MBeans" tab, as shown in
+the image below, to understand the basic status of the service
Review Comment:
Why add blank line here? And why split the sentence into 2 line.
##########
docs/UserGuide/Monitor-Alert/Metric-Tool.md:
##########
@@ -298,15 +411,22 @@ The relevant configuration of the metric module is in `conf/iotdb-{datanode/conf
configuration items support hot loading through the `load configuration` command.
### 5.1. JMX
-For metrics exposed externally using JMX, you can view them through Jconsole. After entering the Jconsole monitoring page, you will first see an overview of various running conditions of IoTDB. Here you can see heap memory information, thread information, class information, and the server's CPU usage.
+
+For metrics exposed externally using JMX, you can view them through Jconsole. After entering the Jconsole monitoring
+page, you will first see an overview of various running conditions of IoTDB. Here you can see heap memory information,
+thread information, class information, and the server's CPU usage.
#### 5.1.1. Obtain metric data
-After connecting to JMX, you can find the "MBean" named "org.apache.iotdb.metrics" through the "MBeans" tab, and you can view the specific values of all monitoring metrics in the sidebar.
+
+After connecting to JMX, you can find the "MBean" named "org.apache.iotdb.metrics" through the "MBeans" tab, and you can
+view the specific values of all monitoring metrics in the sidebar.
Review Comment:
Why add blank line here? And why split the sentence into 2 line.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@iotdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org