Skip to content

Commit 10a41f2

Browse files
leto-bbqleto-bbq
committed
docs: add metric configs to node config manuals
1 parent ff24294 commit 10a41f2

12 files changed

Lines changed: 508 additions & 4 deletions

‎src/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,3 +221,39 @@ The global configuration of cluster is in ConfigNode.
221221
| Effective | After restarting system |
222222

223223
### 2.6 Metric Configuration
224+
225+
* cn\_metric\_reporter\_list
226+
227+
| Name | cn\_metric\_reporter\_list |
228+
|:-----------:|:--------------------------------------|
229+
| Description | Systems for reporting ConfigNode metrics. |
230+
| Type | String |
231+
| Default | None |
232+
| Effective | After restarting system |
233+
234+
* cn\_metric\_level
235+
236+
| Name | cn\_metric\_level |
237+
|:-----------:|:------------------------------------|
238+
| Description | Level of detail for ConfigNode metrics. |
239+
| Type | String |
240+
| Default | IMPORTANT |
241+
| Effective | After restarting system |
242+
243+
* cn\_metric\_async\_collect\_period
244+
245+
| Name | cn\_metric\_async\_collect\_period |
246+
|:-----------:|:------------------------------------------------------------|
247+
| Description | Period for asynchronous metric collection in ConfigNode (in seconds). |
248+
| Type | int |
249+
| Default | 5 |
250+
| Effective | After restarting system |
251+
252+
* cn\_metric\_prometheus\_reporter\_port
253+
254+
| Name | cn\_metric\_prometheus\_reporter\_port |
255+
|:-----------:|:------------------------------------------|
256+
| Description | Port for Prometheus metric reporting in ConfigNode. |
257+
| Type | int |
258+
| Default | 9091 |
259+
| Effective | After restarting system |

‎src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,51 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
386386

387387
### 4.6 Metric Configuration
388388

389+
* dn\_metric\_reporter\_list
390+
391+
| Name | dn\_metric\_reporter\_list |
392+
|:-----------:|:--------------------------------------|
393+
| Description | Systems for reporting DataNode metrics. |
394+
| Type | String |
395+
| Default | None |
396+
| Effective | After restarting system |
397+
398+
* dn\_metric\_level
399+
400+
| Name | dn\_metric\_level |
401+
|:-----------:|:------------------------------------|
402+
| Description | Level of detail for DataNode metrics. |
403+
| Type | String |
404+
| Default | IMPORTANT |
405+
| Effective | After restarting system |
406+
407+
* dn\_metric\_async\_collect\_period
408+
409+
| Name | dn\_metric\_async\_collect\_period |
410+
|:-----------:|:------------------------------------------------------------|
411+
| Description | Period for asynchronous metric collection in DataNode (in seconds). |
412+
| Type | int |
413+
| Default | 5 |
414+
| Effective | After restarting system |
415+
416+
* dn\_metric\_prometheus\_reporter\_port
417+
418+
| Name | dn\_metric\_prometheus\_reporter\_port |
419+
|:-----------:|:------------------------------------------|
420+
| Description | Port for Prometheus metric reporting in DataNode. |
421+
| Type | int |
422+
| Default | 9092 |
423+
| Effective | After restarting system |
424+
425+
* dn\_metric\_internal\_reporter\_type
426+
427+
| Name | dn\_metric\_internal\_reporter\_type |
428+
|:-----------:|:------------------------------------------------------------|
429+
| Description | Internal reporter types for DataNode metrics. For internal monitoring and checking that the data has been successfully written and refreshed. |
430+
| Type | String |
431+
| Default | IOTDB |
432+
| Effective | After restarting system |
433+
389434
## 5. Enable GC log
390435

391436
GC log is off by default.

‎src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,51 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
386386

387387
### 4.6 Metric Configuration
388388

389+
* dn\_metric\_reporter\_list
390+
391+
| Name | dn\_metric\_reporter\_list |
392+
|:-----------:|:--------------------------------------|
393+
| Description | Systems for reporting DataNode metrics. |
394+
| Type | String |
395+
| Default | None |
396+
| Effective | After restarting system |
397+
398+
* dn\_metric\_level
399+
400+
| Name | dn\_metric\_level |
401+
|:-----------:|:------------------------------------|
402+
| Description | Level of detail for DataNode metrics. |
403+
| Type | String |
404+
| Default | IMPORTANT |
405+
| Effective | After restarting system |
406+
407+
* dn\_metric\_async\_collect\_period
408+
409+
| Name | dn\_metric\_async\_collect\_period |
410+
|:-----------:|:------------------------------------------------------------|
411+
| Description | Period for asynchronous metric collection in DataNode (in seconds). |
412+
| Type | int |
413+
| Default | 5 |
414+
| Effective | After restarting system |
415+
416+
* dn\_metric\_prometheus\_reporter\_port
417+
418+
| Name | dn\_metric\_prometheus\_reporter\_port |
419+
|:-----------:|:------------------------------------------|
420+
| Description | Port for Prometheus metric reporting in DataNode. |
421+
| Type | int |
422+
| Default | 9092 |
423+
| Effective | After restarting system |
424+
425+
* dn\_metric\_internal\_reporter\_type
426+
427+
| Name | dn\_metric\_internal\_reporter\_type |
428+
|:-----------:|:------------------------------------------------------------|
429+
| Description | Internal reporter types for DataNode metrics. For internal monitoring and checking that the data has been successfully written and refreshed. |
430+
| Type | String |
431+
| Default | IOTDB |
432+
| Effective | After restarting system |
433+
389434
## 5. Enable GC log
390435

391436
GC log is off by default.

‎src/UserGuide/latest/Reference/ConfigNode-Config-Manual.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,3 +221,39 @@ The global configuration of cluster is in ConfigNode.
221221
| Effective | After restarting system |
222222

223223
### 2.6 Metric Configuration
224+
225+
* cn\_metric\_reporter\_list
226+
227+
| Name | cn\_metric\_reporter\_list |
228+
|:-----------:|:--------------------------------------|
229+
| Description | Systems for reporting ConfigNode metrics. |
230+
| Type | String |
231+
| Default | None |
232+
| Effective | After restarting system |
233+
234+
* cn\_metric\_level
235+
236+
| Name | cn\_metric\_level |
237+
|:-----------:|:------------------------------------|
238+
| Description | Level of detail for ConfigNode metrics. |
239+
| Type | String |
240+
| Default | IMPORTANT |
241+
| Effective | After restarting system |
242+
243+
* cn\_metric\_async\_collect\_period
244+
245+
| Name | cn\_metric\_async\_collect\_period |
246+
|:-----------:|:------------------------------------------------------------|
247+
| Description | Period for asynchronous metric collection in ConfigNode (in seconds). |
248+
| Type | int |
249+
| Default | 5 |
250+
| Effective | After restarting system |
251+
252+
* cn\_metric\_prometheus\_reporter\_port
253+
254+
| Name | cn\_metric\_prometheus\_reporter\_port |
255+
|:-----------:|:------------------------------------------|
256+
| Description | Port for Prometheus metric reporting in ConfigNode. |
257+
| Type | int |
258+
| Default | 9091 |
259+
| Effective | After restarting system |

‎src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,51 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
386386

387387
### 4.6 Metric Configuration
388388

389+
* dn\_metric\_reporter\_list
390+
391+
| Name | dn\_metric\_reporter\_list |
392+
|:-----------:|:--------------------------------------|
393+
| Description | Systems for reporting DataNode metrics. |
394+
| Type | String |
395+
| Default | None |
396+
| Effective | After restarting system |
397+
398+
* dn\_metric\_level
399+
400+
| Name | dn\_metric\_level |
401+
|:-----------:|:------------------------------------|
402+
| Description | Level of detail for DataNode metrics. |
403+
| Type | String |
404+
| Default | IMPORTANT |
405+
| Effective | After restarting system |
406+
407+
* dn\_metric\_async\_collect\_period
408+
409+
| Name | dn\_metric\_async\_collect\_period |
410+
|:-----------:|:------------------------------------------------------------|
411+
| Description | Period for asynchronous metric collection in DataNode (in seconds). |
412+
| Type | int |
413+
| Default | 5 |
414+
| Effective | After restarting system |
415+
416+
* dn\_metric\_prometheus\_reporter\_port
417+
418+
| Name | dn\_metric\_prometheus\_reporter\_port |
419+
|:-----------:|:------------------------------------------|
420+
| Description | Port for Prometheus metric reporting in DataNode. |
421+
| Type | int |
422+
| Default | 9092 |
423+
| Effective | After restarting system |
424+
425+
* dn\_metric\_internal\_reporter\_type
426+
427+
| Name | dn\_metric\_internal\_reporter\_type |
428+
|:-----------:|:------------------------------------------------------------|
429+
| Description | Internal reporter types for DataNode metrics. For internal monitoring and checking that the data has been successfully written and refreshed. |
430+
| Type | String |
431+
| Default | IOTDB |
432+
| Effective | After restarting system |
433+
389434
## 5. Enable GC log
390435

391436
GC log is off by default.

‎src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,51 @@ The permission definitions are in ${IOTDB\_CONF}/conf/jmx.access.
386386

387387
### 4.6 Metric Configuration
388388

389+
* dn\_metric\_reporter\_list
390+
391+
| Name | dn\_metric\_reporter\_list |
392+
|:-----------:|:--------------------------------------|
393+
| Description | Systems for reporting DataNode metrics. |
394+
| Type | String |
395+
| Default | None |
396+
| Effective | After restarting system |
397+
398+
* dn\_metric\_level
399+
400+
| Name | dn\_metric\_level |
401+
|:-----------:|:------------------------------------|
402+
| Description | Level of detail for DataNode metrics. |
403+
| Type | String |
404+
| Default | IMPORTANT |
405+
| Effective | After restarting system |
406+
407+
* dn\_metric\_async\_collect\_period
408+
409+
| Name | dn\_metric\_async\_collect\_period |
410+
|:-----------:|:------------------------------------------------------------|
411+
| Description | Period for asynchronous metric collection in DataNode (in seconds). |
412+
| Type | int |
413+
| Default | 5 |
414+
| Effective | After restarting system |
415+
416+
* dn\_metric\_prometheus\_reporter\_port
417+
418+
| Name | dn\_metric\_prometheus\_reporter\_port |
419+
|:-----------:|:------------------------------------------|
420+
| Description | Port for Prometheus metric reporting in DataNode. |
421+
| Type | int |
422+
| Default | 9092 |
423+
| Effective | After restarting system |
424+
425+
* dn\_metric\_internal\_reporter\_type
426+
427+
| Name | dn\_metric\_internal\_reporter\_type |
428+
|:-----------:|:------------------------------------------------------------|
429+
| Description | Internal reporter types for DataNode metrics. For internal monitoring and checking that the data has been successfully written and refreshed. |
430+
| Type | String |
431+
| Default | IOTDB |
432+
| Effective | After restarting system |
433+
389434
## 5. Enable GC log
390435

391436
GC log is off by default.

‎src/zh/UserGuide/Master/Tree/Reference/ConfigNode-Config-Manual.md‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,4 +207,40 @@ IoTDB 集群的全局配置通过 ConfigNode 配置。
207207
| 默认值 | 300 |
208208
| 改后生效方式 | 重启服务生效 |
209209

210-
### 2.6 Metric 监控配置
210+
### 2.6 Metric 监控配置
211+
212+
* cn\_metric\_reporter\_list
213+
214+
| 名字 | cn\_metric\_reporter\_list |
215+
|:------:|:--------------------------------------------|
216+
| 描述 | confignode 中用于配置监控模块的数据需要报告的系统。 |
217+
| 类型 | String |
218+
| 默认值 | 无 |
219+
| 改后生效方式 | 重启服务生效 |
220+
221+
* cn\_metric\_level
222+
223+
| 名字 | cn\_metric\_level |
224+
|:------:|:-----------------------------------|
225+
| 描述 | confignode 中控制监控模块收集数据的详细程度 |
226+
| 类型 | String |
227+
| 默认值 | IMPORTANT |
228+
| 改后生效方式 | 重启服务生效 |
229+
230+
* cn\_metric\_async\_collect\_period
231+
232+
| 名字 | cn\_metric\_async\_collect\_period |
233+
|:------:|:-----------------------------------------|
234+
| 描述 | confignode 中某些监控数据异步收集的周期，单位是秒。 |
235+
| 类型 | int |
236+
| 默认值 | 5 |
237+
| 改后生效方式 | 重启服务生效 |
238+
239+
* cn\_metric\_prometheus\_reporter\_port
240+
241+
| 名字 | cn\_metric\_prometheus\_reporter\_port |
242+
|:------:|:---------------------------------------------|
243+
| 描述 | confignode 中 Prometheus 报告者用于监控数据报告的端口号。 |
244+
| 类型 | int |
245+
| 默认值 | 9091 |
246+
| 改后生效方式 | 重启服务生效 |

‎src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,51 @@ IoTDB DataNode 与 Standalone 模式共用一套配置文件，均位于 IoTDB
381381

382382
### 3.6 Metric 配置
383383

384+
* dn\_metric\_reporter\_list
385+
386+
| 名字 | dn\_metric\_reporter\_list |
387+
|:------:|:------------------------------------------|
388+
| 描述 | DataNode 中用于配置监控模块的数据需要报告的系统。 |
389+
| 类型 | String |
390+
| 默认值 | 无 |
391+
| 改后生效方式 | 重启服务生效 |
392+
393+
* dn\_metric\_level
394+
395+
| 名字 | dn\_metric\_level |
396+
|:------:|:---------------------------------|
397+
| 描述 | DataNode 中控制监控模块收集数据的详细程度 |
398+
| 类型 | String |
399+
| 默认值 | IMPORTANT |
400+
| 改后生效方式 | 重启服务生效 |
401+
402+
* dn\_metric\_async\_collect\_period
403+
404+
| 名字 | dn\_metric\_async\_collect\_period |
405+
|:------:|:---------------------------------------|
406+
| 描述 | DataNode 中某些监控数据异步收集的周期，单位是秒。 |
407+
| 类型 | int |
408+
| 默认值 | 5 |
409+
| 改后生效方式 | 重启服务生效 |
410+
411+
* dn\_metric\_prometheus\_reporter\_port
412+
413+
| 名字 | dn\_metric\_prometheus\_reporter\_port |
414+
|:------:|:-------------------------------------------|
415+
| 描述 | DataNode 中 Prometheus 报告者用于监控数据报告的端口号。 |
416+
| 类型 | int |
417+
| 默认值 | 9092 |
418+
| 改后生效方式 | 重启服务生效 |
419+
420+
* dn\_metric\_internal\_reporter\_type
421+
422+
| 名字 | dn\_metric\_internal\_reporter\_type |
423+
|:------:|:-----------------------------------------------------------|
424+
| 描述 | DataNode 中监控模块内部报告者的种类，用于内部监控和检查数据是否已经成功写入和刷新。 |
425+
| 类型 | String |
426+
| 默认值 | IOTDB |
427+
| 改后生效方式 | 重启服务生效 |
428+
384429
## 4. 开启 GC 日志
385430

386431
GC 日志默认是关闭的。为了性能调优，用户可能会需要收集 GC 信息。

0 commit comments

Comments
 (0)