This is an automated email from the ASF dual-hosted git repository. zhaoqingran pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push: new 841220675 [doc] add help doc for flink monitoring (#1893) 841220675 is described below commit 841220675acd9789820ca7ae1ece804876d8cb5d Author: feiyang li <3200105...@zju.edu.cn> AuthorDate: Tue Apr 30 16:04:41 2024 +0800 [doc] add help doc for flink monitoring (#1893) --- home/docs/help/flink.md | 39 ++++++++++++++++++++++ home/docs/help/guide.md | 1 + .../current/help/flink.md | 38 +++++++++++++++++++++ .../current/help/guide.md | 1 + home/sidebars.json | 1 + 5 files changed, 80 insertions(+) diff --git a/home/docs/help/flink.md b/home/docs/help/flink.md new file mode 100644 index 000000000..2115a1f0b --- /dev/null +++ b/home/docs/help/flink.md @@ -0,0 +1,39 @@ +--- +id: flink +title: Monitoring Flink +sidebar_label: Flink +keywords: [open source monitoring tool, open source flink monitoring tool] +--- + +> Collect and monitor the general performance Metrics of Flink. + + +### Configuration parameter + +| Parameter Name | Parameter Help Description | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | The monitored peer IPV4, IPV6, or domain name. Note: Do not include protocol headers (e.g., https://, http://). | +| Task Name | Identifier for this monitoring task, name must be unique. | +| Port | Monitoring port. | +| Query Timeout | Sets the timeout for JVM connection in milliseconds, default is 3000 milliseconds. | +| SSL | Whether to enable SSL (default is off). | +| Username | Connection username. | +| Password | Connection password. | +| Collection Interval | Interval for periodic data collection during monitoring, in seconds. The minimum settable interval is 30 seconds. | +| Whether to detect | Whether to perform a probe check for monitoring availability before adding a new monitor; operations proceed if successful. | +| Description Remarks | Additional identifiers and descriptions for this monitoring, where users can note information. | + +### Collection Metrics + +#### Metrics Set:Overview + +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|-------------------------| +| slots_total | Units | Total number of slots. | +| slots_used | Units | Number of slots used. | +| task_total | Units | Total number of tasks. | +| jobs_running | Units | Number of jobs running. | +| jobs_failed | Units | Number of jobs failed. | + + + diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md index 4ec711a79..ae78ec39a 100644 --- a/home/docs/help/guide.md +++ b/home/docs/help/guide.md @@ -67,6 +67,7 @@ sidebar_label: Help Center  👉 [Clickhouse](clickhouse) <br />  👉 [ElasticSearch](elasticsearch) <br /> + 👉 [Flink](flink) <br /> ### Network monitoring diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md new file mode 100644 index 000000000..ef260f4dc --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md @@ -0,0 +1,38 @@ +--- +id: flink +title: 监控:Flink +sidebar_label: Flink Monitor +keywords: [开源监控系统, 开源 Flink 监控] +--- + +> 对 Flink 流引擎的通用指标进行测量监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 监控的端口 | +| 查询超时时间 | 设置JVM连接的超时时间,单位ms毫秒,默认3000毫秒。 | +| SSL | 是否开启SSL(默认关闭) | +| 用户名 | 连接用户名 | +| 密码 | 连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:overview + +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|----------| +| slots_total | 个 | 插槽总数 | +| slots_used | 个 | 已用插槽数 | +| task_total | 个 | 任务总数 | +| jobs_running | 个 | 正在运行的任务数 | +| jobs_failed | 个 | 已经失败的任务数 | + + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md index ca19e1b6b..187df8cf4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md @@ -67,6 +67,7 @@ sidebar_label: 帮助入门  👉 [Clickhouse](clickhouse) <br />  👉 [ElasticSearch](elasticsearch) <br /> +  👉 [Flink](flink) <br /> ### 网络监控 diff --git a/home/sidebars.json b/home/sidebars.json index f15c1c37d..029fd2223 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -213,6 +213,7 @@ "label": "bigdata", "items": [ "help/spark", + "help/flink", "help/doris_be", "help/doris_fe", "help/hadoop", --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@hertzbeat.apache.org For additional commands, e-mail: notifications-h...@hertzbeat.apache.org