This is an automated email from the ASF dual-hosted git repository.
gosonzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 410e152 [INLONG-218]Add Metric documents of TubeMQ (#219)
410e152 is described below
commit 410e1525edff7c3bff23953fbba355936b22bd77
Author: gosonzhang <[email protected]>
AuthorDate: Wed Dec 8 19:52:09 2021 +0800
[INLONG-218]Add Metric documents of TubeMQ (#219)
---
docs/modules/tubemq/tubemq_metrics.md | 53 +++++++++++++++++++++
.../current/modules/tubemq/tubemq_metrics.md | 54 ++++++++++++++++++++++
2 files changed, 107 insertions(+)
diff --git a/docs/modules/tubemq/tubemq_metrics.md
b/docs/modules/tubemq/tubemq_metrics.md
new file mode 100644
index 0000000..2219e22
--- /dev/null
+++ b/docs/modules/tubemq/tubemq_metrics.md
@@ -0,0 +1,53 @@
+---
+title: TubeMQ Metrics
+---
+
+## 1 Introduction to TubeMQ metric set
+
+TubeMQ has supported the output of JMX metric items since version 0.12.0. At
present, it mainly adds overall operating metrics to the Master and Broker
modules; in the future, we will consider adding corresponding metrics to the
Producer and Consumer modules. At the same time, the metrics of the Master and
Broker modules are implemented as needed to continue to expand.
+
+The indicator output format currently only supports the standard JMX access
method, next, Prometheus and HTTP access mode will be added. The metrics'
values are obtained through the getMetrics() and getAndReSetMetrics() methods:
getMetrics() only pulls the indicator data, and does not change the current
data metric value; the getAndReSetMetrics() method performs the pull of the
current metric data, for the Counter and The maximum and minimum metrics are
reset to facilitate business re-st [...]
+
+## 2 Master Metric Items
+
+| Metric Item | Metric Type |
Desc |
+| ------------------------- | --------------------------- |
------------------------------------------ |
+| consume_group_cnt | Gauge | The number of consumer groups currently online |
+| consume_group_timeout_cnt | Counter | The total number of consumer group
timeouts since the last count |
+| client_balance_group_cnt | Gauge | The number of consumer groups allocated
by the currently registered client partition |
+| clt_balance_timeout_cnt | Counter | The total number of timeouts of client
partition allocation consumer group timeouts since the last statistics |
+| consumer_online_cnt | Gauge | Number of consumers currently online |
+| consumer_timeout_cnt | Counter | The total number of consumer timeout exits
since the last count |
+| producer_online_cnt | Gauge | The number of producers currently online |
+| producer_timeout_cnt | Counter | The total number of producer timeout exits
since the last count |
+| broker_configure_cnt | Gauge | Number of Broker records currently configured
|
+| broker_online_cnt | Gauge | Number of Broker nodes currently online |
+| broker_timeout_cnt | Counter | The total number of broker node timeouts
since the last count |
+| broker_abn_current_cnt | Gauge | Number of Broker nodes that currently
report exceptions |
+| broker_abn_total_cnt | Counter | The number of Broker nodes that have
reported exceptions since the last statistics |
+| broker_fbd_current_cnt | Gauge | The number of Broker nodes that are
currently reporting exceptions and are prohibited from serving |
+| broker_fbd_total_cnt | Counter | The number of Broker nodes that have
reported exceptions and are prohibited from serving since the last statistics |
+| svrbalance_duration | Gauge | Current server load balancing continuous-time
|
+| svrbalance_duration_min | Gauge | Current server load balancing minimum time
consumption |
+| svrbalance_duration_max | Gauge | Current server load balancing maximum time
consumption |
+| svrbal_reset_duration_min | Gauge | The current minimum equalization time to
reset the equalization |
+| svrbal_reset_duration_max | Gauge | The maximum equalization time
consumption of the current reset equalization |
+| svrbal_con_consumer_cnt | Gauge | The number of clients currently processing
connection tasks |
+| svrbal_discon_consumer_cnt | Gauge | The number of clients currently
processing disconnected tasks |
+
+## 3 Broker Metric Items
+
+| Metric Item | Metric Type |
Desc |
+| ------------------------- | --------------------------- |
------------------------------------------ |
+| fSync_duration_min | Gauge | Current data synchronization to file minimum
time consumption |
+| fSync_duration_max | Gauge | Maximum time consumption of current data
synchronization to file |
+| zkSync_duration_min | Gauge | Current data synchronization to ZooKeeper
minimum time consumption |
+| zkSync_duration_max | Gauge | Maximum time consumption of current data
synchronization to ZooKeeper |
+| zk_exception_cnt | Counter | Number of exceptions thrown during ZooKeeper
operations |
+| online_timeout_cnt | Counter | The total number of times the master reported
the heartbeat timeout of this node |
+| io_exception_cnt | Counter | Total number of IOExceptions reported by
reading and writing data disks |
+| consumer_online_cnt | Gauge | Total number of consumers registered to this
node |
+| consumer_timeout_cnt | Counter | The total number of heartbeat timeouts for
consumers registered on this node |
+
+---
+<a href="#top">Back to top</a>
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq_metrics.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq_metrics.md
new file mode 100644
index 0000000..ada6e81
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/tubemq_metrics.md
@@ -0,0 +1,54 @@
+---
+title: TubeMQ指标
+---
+
+## 1 TubeMQ指标集介绍
+
+TubeMQ从0.12.0版本开始支持Jmx的指标项输出，目前主要在Master、Broker模块上增加整体的运行指标；后续考虑在Producer、Consumer模块上增加对应指标，同时Master、Broker模块的指标根据需要进行继续扩充。
+
+指标输出的形式目前只支持标准的Jmx访问方式，接下来将增加Prometheus，以及HTTP接口访问模式的指标输出。指标通过getMetrics()及getAndReSetMetrics()方法进行获取，getMetrics()仅进行指标数据的拉取，并不改变当前的数据指标值；getAndReSetMetrics()方法在完成当前指标数据的拉取后，对于Counter以及极大值、极小值的指标进行重置，便于业务重新统计系统运行情况。
+
+## 2 Master指标项
+
+| 指标项 | 指标类型 | 含义
|
+| ------------------------- | --------------------------- |
------------------------------------------ |
+| consume_group_cnt | Gauge |
当前在线的消费组个数 |
+| consume_group_timeout_cnt | Counter |
自上次统计以来消费组超时的总次数 |
+| client_balance_group_cnt | Gauge |
当前注册的客户端分区分配的消费组个数 |
+| clt_balance_timeout_cnt | Counter |
自上次统计以来客户端分区分配消费组超时的总次数 |
+| consumer_online_cnt | Gauge |
当前在线的消费者个数 |
+| consumer_timeout_cnt | Counter |
自上次统计以来消费者超时退出的总次数 |
+| producer_online_cnt | Gauge |
当前在线的生产者个数 |
+| producer_timeout_cnt | Counter |
自上次统计以来生产者超时退出的总次数数 |
+| broker_configure_cnt | Gauge |
当前配置的Broker记录个数 |
+| broker_online_cnt | Gauge |
当前在线的Broker节点个数 |
+| broker_timeout_cnt | Counter |
自上次统计以来Broker节点超时的总次数 |
+| broker_abn_current_cnt | Gauge |
当前上报异常的Broker节点个数 |
+| broker_abn_total_cnt | Counter |
自上次统计以来上报异常的Broker节点个数 |
+| broker_fbd_current_cnt | Gauge |
当前上报异常并被禁止服务的Broker节点个数 |
+| broker_fbd_total_cnt | Counter |
自上次统计以来上报异常并被禁止服务的Broker节点个数 |
+| svrbalance_duration | Gauge |
当前服务器负载均衡持续的时耗 |
+| svrbalance_duration_min | Gauge |
当前服务器负载均衡最小时耗 |
+| svrbalance_duration_max | Gauge |
当前服务器负载均衡最大时耗 |
+| svrbal_reset_duration_min | Gauge |
当前重置均衡的最小均衡时耗 |
+| svrbal_reset_duration_max | Gauge |
当前重置均衡的最大均衡时耗 |
+| svrbal_con_consumer_cnt | Gauge |
当前在处理连接任务的客户端个数 |
+| svrbal_discon_consumer_cnt | Gauge |
当前在处理断连任务的客户端个数 |
+
+## 3 Broker指标项
+
+| 指标项 | 指标类型 | 含义
|
+| ------------------------- | --------------------------- |
------------------------------------------ |
+| fSync_duration_min | Gauge |
当前数据同步到文件最小时耗 |
+| fSync_duration_max | Gauge |
当前数据同步到文件最大时耗 |
+| zkSync_duration_min | Gauge |
当前数据同步到ZooKeeper最小时耗 |
+| zkSync_duration_max | Gauge |
当前数据同步到ZooKeeper最大时耗 |
+| zk_exception_cnt | Counter |
进行ZooKeeper操作抛异常的次数 |
+| online_timeout_cnt | Counter |
Master报本节点心跳超时的总次数 |
+| io_exception_cnt | Counter |
读写数据磁盘报IOException异常的总次数 |
+| consumer_online_cnt | Gauge |
注册到本节点的消费者总个数 |
+| consumer_timeout_cnt | Counter |
本节点注册的消费者出现心跳超时的总次数 |
+
+
+---
+<a href="#top">Back to top</a>
\ No newline at end of file
