@@ -29,16 +29,11 @@ Metric Module
2929 - IoTDB Reporter
3030
3131- [ 1. Design] ( #1-design )
32- - [ 2. Test Report] ( #2-test-report )
33- - [ 2.1. Test Environment] ( #21-test-environment )
34- - [ 2.2. Test Metrics] ( #22-test-metrics )
35- - [ 2.3. Test parameters] ( #23-test-parameters )
36- - [ 2.4. Test Result] ( #24-test-result )
37- - [ 3. How to use?] ( #3-how-to-use )
38- - [ 3.1. Configuration] ( #31-configuration )
39- - [ 3.2. Use Guide in IoTDB Server Module] ( #32-use-guide-in-iotdb-server-module )
40- - [ 4. How to implement your own metric framework?] ( #4-how-to-implement-your-own-metric-framework )
41- - [ 5. Some docs] ( #5-some-docs )
32+ - [ 2. How to use?] ( #2-how-to-use )
33+ - [ 2.1. Configuration] ( #21-configuration )
34+ - [ 2.2. Use Guide in IoTDB Server Module] ( #22-use-guide-in-iotdb-server-module )
35+ - [ 3. How to implement your own metric framework?] ( #3-how-to-implement-your-own-metric-framework )
36+ - [ 4. Some docs] ( #4-some-docs )
4237
4338# 1. Design
4439> The acquisition system consists of following four parts.
@@ -57,9 +52,9 @@ Metric Module
5752 3 . Provide the ability to load metric sets.
5853 4 . Provide the access of metricManager and CompositeReporter.
5954
60- # 3 . How to use?
55+ # 2 . How to use?
6156
62- ## 3 .1. Configuration
57+ ## 2 .1. Configuration
6358Configure the metrics module through ` iotdb-system.properties ` . The main options supported by the current code are listed below.
6459
6560| properties | meaning | example |
@@ -71,7 +66,7 @@ Configure the metrics module through `iotdb-system.properties`. The main options
7166
7267More details, see the User Guide and the ` iotdb-system.properties.template ` file.
7368
74- ## 3 .2. Use Guide in IoTDB Server Module
69+ ## 2 .2. Use Guide in IoTDB Server Module
75701 . ` MetricService ` is registered as an ` IService ` in both DataNode and ConfigNode modules. Enable it with ` dn(cn)_enable_metric=true ` .
76712 . In server-side code you can use metrics through ` MetricService.getInstance() ` , for example:
7772
@@ -81,7 +76,7 @@ MetricService.getInstance().count(1, "operation_count", MetricLevel.IMPORTANT, "
8176
82773 . If you want to bind or remove a metric set, use ` addMetricSet(IMetricSet) ` and ` removeMetricSet(IMetricSet) ` .
8378
84- # 4 . How to implement your own metric framework?
79+ # 3 . How to implement your own metric framework?
85801 . Implement your metric types and an ` AbstractMetricManager ` .
8681 1 . The built-in implementation provides Counter, AutoGauge, Gauge, Histogram, Rate and Timer.
87822 . Implement your reporters.
@@ -94,6 +89,6 @@ MetricService.getInstance().count(1, "operation_count", MetricLevel.IMPORTANT, "
9489 1 . ` src/main/resources/META-INF/services/org.apache.iotdb.metrics.AbstractMetricManager `
9590 2 . ` src/main/resources/META-INF/services/org.apache.iotdb.metrics.reporter.JmxReporter `
9691
97- # 5 . Some docs
92+ # 4 . Some docs
98931 . <a href = " https://iotdb.apache.org/UserGuide/latest/Tools-System/Monitor-Tool.html " >Metric Tool</a >
99942 . <a href = " https://iotdb.apache.org/zh/UserGuide/latest/Tools-System/Monitor-Tool.html " >Metric Tool(zh)</a >
0 commit comments