This is an automated email from the ASF dual-hosted git repository.
dockerzhang 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 25dd584 [InLong-1853][Feature][Agent] should provide docs for jmx
metrics in agent (#201)
25dd584 is described below
commit 25dd584ad21fbb13320714979c668592bb27f431
Author: ziruipeng <[email protected]>
AuthorDate: Mon Nov 29 16:24:22 2021 +0800
[InLong-1853][Feature][Agent] should provide docs for jmx metrics in agent
(#201)
---
docs/modules/agent/architecture.md | 39 ++++++++++++++++++++
.../current/modules/agent/architecture.md | 42 ++++++++++++++++++++++
2 files changed, 81 insertions(+)
diff --git a/docs/modules/agent/architecture.md
b/docs/modules/agent/architecture.md
index b369425..d9c89c8 100644
--- a/docs/modules/agent/architecture.md
+++ b/docs/modules/agent/architecture.md
@@ -41,6 +41,45 @@ This type of collection reads binlog and restores data by
configuring mysql slav
Need to pay attention to multi-threaded parsing when binlog is read, and
multi-threaded parsing data needs to be labeled in order
The code is based on the old version of dbsync, the main modification is to
change the sending of tdbus-sender to push to agent-channel for integration
+##4 Monitoring indicator configuration instructions
+Agent provides the ability of monitoring indicators in JMX mode, and the
monitoring indicators have been registered to MBeanServer
+Users can add similar JMX (port and authentication are adjusted according to
the situation) to the startup parameters of the Agent to realize the collection
of monitoring indicators from the remote end.
+```Shell
+-Dcom.sun.management.jmxremote
+-Djava.rmi.server.hostname=127.0.0.1
+-Dcom.sun.management.jmxremote.port=9999
+-Dcom.sun.management.jmxremote.authenticate=false
+-Dcom.sun.management.jmxremote.ssl=false
+```
+
+The agent indicators are divided into the following items, and the indicators
are as follows:
+
+AgentTaskMetric
+
+| property | info |
+| ---- | ---- |
+| runningTasks | tasks currently being executed |
+| retryingTasks | Tasks that are currently being retried |
+| fatalTasks | The total number of currently failed tasks |
+
+
+JobMetrics
+
+| property | info |
+| ---- | ---- |
+| runningJobs | the total number of currently running jobs |
+| fatalJobs | the total number of currently failed jobs |
+
+PluginMetric
+
+| property | info |
+| ---- | ---- |
+| readNum | the number of reads |
+| sendNum | the number of sent items |
+| sendFailedNum | the number of failed sending |
+| readFailedNum | the number of failed reads |
+| readSuccessNum | the number of successful reads |
+| sendSuccessNum | the number of successfully sent |
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/architecture.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/architecture.md
index 677898f..68b3590 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/architecture.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/architecture.md
@@ -43,6 +43,48 @@ SQL正则分解，转化成多条SQL语句
这种方式采集属于文件采集，只不过metric采集的时候，单行的数据有格式规范
+## 4 监控指标配置说明
+
+Agent提供了JMX方式的监控指标能力，监控指标已经注册到MBeanServer
+用户可以在Agent的启动参数中增加如下类似JMX定义（端口和鉴权根据情况进行调整），实现监控指标从远端采集。
+
+```shell
+ -Dcom.sun.management.jmxremote
+ -Djava.rmi.server.hostname=127.0.0.1
+ -Dcom.sun.management.jmxremote.port=9999
+ -Dcom.sun.management.jmxremote.authenticate=false
+ -Dcom.sun.management.jmxremote.ssl=false
+```
+
+Agent指标分为以下几项, 各项的属性分别为：
+
+
+AgentTaskMetric
+
+| 属性名称 | 说明 |
+| ---- | ---- |
+| runningTasks | 当前正在执行的任务 |
+| retryingTasks | 当前正在重试的任务 |
+| fatalTasks | 当前失败的任务总数 |
+
+
+JobMetrics
+
+| 属性名称 | 说明 |
+| ---- | ---- |
+| runningJobs | 当前正在运行的job总数 |
+| fatalJobs | 当前失败的job总数 |
+
+PluginMetric
+
+| 属性名称 | 说明 |
+| ---- | ---- |
+| readNum | 当前正在运行的job总数 |
+| sendNum | 当前失败的job总数 |
+| sendFailedNum | 发送失败条数 |
+| readFailedNum | 读取失败条数 |
+| readSuccessNum | 读取成功条数 |
+| sendSuccessNum | 发送成功条数 |
