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/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new cbb67f8be [INLONG-5386][TubeMQ] Supports reporting metrics data
through Prometheus (#512)
cbb67f8be is described below
commit cbb67f8be7b9de193b4ae3ee2a59b0523ec7080f
Author: Goson Zhang <[email protected]>
AuthorDate: Tue Aug 9 16:30:35 2022 +0800
[INLONG-5386][TubeMQ] Supports reporting metrics data through Prometheus
(#512)
---
docs/modules/tubemq/configure_introduction.md | 36 ++++++++++++++++------
.../modules/tubemq/configure_introduction.md | 36 ++++++++++++++++------
2 files changed, 53 insertions(+), 19 deletions(-)
diff --git a/docs/modules/tubemq/configure_introduction.md
b/docs/modules/tubemq/configure_introduction.md
index a883f9320..4223ba658 100644
--- a/docs/modules/tubemq/configure_introduction.md
+++ b/docs/modules/tubemq/configure_introduction.md
@@ -81,6 +81,16 @@ In addition to the back-end system configuration file, the
Master also stores th
| repReplicaAckPolicy | no | int | The response policy of the
replication node data synchronization, the value range of this field is [1, 2,
3], the default is 1: 1 is more than 1/2 majority is valid, 2 is valid for all
nodes, 3 is not Need node response. |
| repStatusCheckTimeoutMs | no | long | Replication status check
interval, optional field, in milliseconds, defaults to 10 seconds. |
+[prometheus]
+> Master uses Prometheus to provide querying metric data, optional
+
+| Name | Required | Type | Description
|
+|-----|------|---------|--------------------------------------------------------------------------------|
+| promEnable | no | boolean | whether to enable prometheus service, optional
configuration, default is false |
+| promClusterName | no | String | cluster name which the node belong to,
default is " InLong " |
+| promHttpPort | no | int | port that prometheus listens to, optional,
default is 9081 |
+
+
**Notice**:
- Based on the need of Docker containerization, the [meta_bdb] above 3
parameters in the master.ini file are all the default settings used, and the
actual information of the Master node needs to be configured when used in
actual networking.
- The IP information of all master nodes should be mapped to the hostName in
the hosts configuration file, such as "10.10.11.205 10-10-11-205"
@@ -166,15 +176,23 @@ In addition to the back-end system configuration file,
the Master also stores th
[audit]
>The Broker uses audit module to report data. When audit is enabled, the
>configuration unit provides related settings. The optional unit has a fixed
>value of "[audit]".
-
-| Name | Required | Type | Description
|
-| ---------------------
|----------|---------|----------------------------------------------------------------------------------------------------------------------------------|
-| auditEnable | no | boolean | Whether to enable audit
report function, optional configuration, default is false
|
-| auditProxyAddr | yes | string | Audit server address
list. Required fields if the auditEnable value is true. The format must be
ip1:port1, ip2:port2, ip3:port3. |
-| auditCacheFilePath | no | string | The absolute file path for
audit cache data. the default value is "/data/inlong/audit".
|
-| auditCacheMaxRows | no | int | The max cache records for audit
cache， the default value is 200000 records
|
-| auditIdProduce | no | int | The audit id value for production,
the default value is 9
|
-| auditIdConsume | no | int | The audit id value for production,
the default value is 10.
|
+| Name | Required | Type | Description
|
+|----------------------|----------|---------|-----------------------------------------------------------------------------------------|
+| auditEnable | no | boolean | Whether to enable audit report
function, optional configuration, default is false |
+| auditProxyAddr | no | string | Audit server address list, the
format must be ip1:port1, ip2:port2, ip3:port3; default is 127.0.0.1:10081
|
+| auditCacheFilePath | no | string | The absolute file path for audit
cache data. the default value is "/data/inlong/audit". |
+| auditCacheMaxRows | no | int | The max cache records for audit
cache， the default value is 200000 records |
+| auditIdProduce | no | int | The audit id value for
production, the default value is 9 |
+| auditIdConsume | no | int | The audit id value for
production, the default value is 10. |
+
+[prometheus]
+> Broker uses Prometheus to provide querying metric data, optional
+
+| Name | Required | Type | Description
|
+|-----|------|---------|--------------------------------------------------------------------------------|
+| promEnable | no | boolean | whether to enable prometheus service, optional
configuration, default is false |
+| promClusterName | no | String | cluster name which the node belong to,
default is " InLong " |
+| promHttpPort | no | int | port that prometheus listens to, optional,
default is 9081 |
---
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
index e44feb1a9..11eb56dbc 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
@@ -83,7 +83,6 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| repReplicaAckPolicy | 否 | int |
节点数据同步时的应答策略，该字段取值范围为[1，2，3]，缺省为1：其中1为超过1/2多数为有效，2为所有节点应答才有效；3为不需要节点应答 |
| repStatusCheckTimeoutMs | 否 | long | 节点状态检查间隔，可选字段，单位毫秒，缺省为10秒 |
-
[tlsSetting]
> Master 启用 TLS 进行传输层数据加密通的相关设置，可选单元，值固定为 "[tlsSetting]"
@@ -97,6 +96,15 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| tlsTrustStorePath | 否 | String |
TLS的TrustStore文件的绝对存储路径+TrustStore文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空 |
| tlsTrustStorePassword | 否 | String |
TLS的TrustStorePassword文件的绝对存储路径+TrustStorePassword文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空
|
+[prometheus]
+> Master 使用 prometheus 提供指标数据查询时的相关配置单元设置，可选配置单元集合 " [prometheus] "
+
+| 配置项 | 是否必选 | 值类型 | 配置说明
|
+|-----|------|---------|---------------------------------------------------------------------------------|
+| promEnable | 否 | boolean | 是否启用 prometheus服务，可选配置，缺省为false
|
+| promClusterName | 否 | String | 启用 prometheus 服务时 服务节点所属于的集群名，缺省值为 "
InLong " |
+| promHttpPort | 否 | int | 启用 prometheus 服务时的侦听端口，可选配置，缺省值为 9081
|
+
**注意**：
-
基于Docker容器化的需要，master.ini文件里对[meta_bdb]如上3个参数部分都是使用的缺省设置，在实际组网使用时需要以Master节点真实信息配置
- Master所有节点的IP信息要在hosts配置文件里构造IP与hostName映射关系，如类似“10.10.11.205 10-10-11-205”
@@ -164,18 +172,26 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| tlsTrustStorePath | 否 | String |
TLS的TrustStore文件的绝对存储路径+TrustStore文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空
|
| tlsTrustStorePassword | 否 | String |
TLS的TrustStorePassword文件的绝对存储路径+TrustStorePassword文件名，在启动TLS功能且启用双向认证时，该字段必填且不能为空
|
-
[audit]
> Broker 使用审计模块来报告数据设置单元，启用审计时，配置单元提供相关设置，该可选配置单位有一个固定值 " [audit] "
-| 配置项 | 是否必选 | 值类型 | 配置说明 |
-|-----| --- | --- |---------------------------------------------------------|
-| auditEnable | 否 | boolean | 是否启用审计上报功能，可选配置，缺省为false
|
-| auditProxyAddr | 是 | String | 审计上报地址，当 auditEnable 为 true 时必填字段，格式必须是
" ip1:port1,ip2:port2,ip3:port3 " |
-| auditCacheFilePath | 否 | String | 审计上报数据的缓存文件路径，缺省为 "
/data/inlong/audit "
|
-| auditCacheMaxRows | 否 | int | 最大审计缓存的数据条数，缺省为2000000条
|
-| auditIdProduce | 否 | int | 上报生产数据的审计ID，缺省值为9
|
-| auditIdConsume | 否 | int | 上报消费数据的审计ID，缺省值为10
|
+| 配置项 | 是否必选 | 值类型 | 配置说明
|
+|-----|------| ---
|---------------------------------------------------------------------------------|
+| auditEnable | 否 | boolean | 是否启用审计上报功能，可选配置，缺省为false
|
+| auditProxyAddr | 否 | String | 审计上报地址，格式必须是 "
ip1:port1,ip2:port2,ip3:port3 ", 缺省值为 127.0.0.1:10081 |
+| auditCacheFilePath | 否 | String | 审计上报数据的缓存文件路径，缺省为 "
/data/inlong/audit " |
+| auditCacheMaxRows | 否 | int | 最大审计缓存的数据条数，缺省为2000000条
|
+| auditIdProduce | 否 | int | 上报生产数据的审计ID，缺省值为9
|
+| auditIdConsume | 否 | int | 上报消费数据的审计ID，缺省值为10
|
+
+[prometheus]
+> Broker 使用 prometheus 提供指标数据查询时的相关配置单元设置，可选配置单元集合 " [prometheus] "
+
+| 配置项 | 是否必选 | 值类型 | 配置说明
|
+|-----|------|---------|---------------------------------------------------------------------------------|
+| promEnable | 否 | boolean | 是否启用 prometheus服务，可选配置，缺省为false
|
+| promClusterName | 否 | String | 启用 prometheus 服务时 服务节点所属于的集群名，缺省值为 "
InLong " |
+| promHttpPort | 否 | int | 启用 prometheus 服务时的侦听端口，可选配置，缺省值为 9081
|
---
<a href="#top">Back to top</a>
