This is an automated email from the ASF dual-hosted git repository. zhengqiwei 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 48eafa138 [Feature] add Apache DolphinScheduler monitoring support (#3656) 48eafa138 is described below commit 48eafa1382e88841e5a0451bfc119717168f1a28 Author: DeleiGuo <delei...@163.com> AuthorDate: Sun Aug 17 10:58:46 2025 +0800 [Feature] add Apache DolphinScheduler monitoring support (#3656) Co-authored-by: Calvin <zhengqi...@apache.org> --- .../main/resources/define/app-dolphinscheduler.yml | 558 +++++++++++++++++++++ home/docs/help/dolphinscheduler.md | 105 ++++ .../current/help/dolphinscheduler.md | 105 ++++ home/sidebars.json | 3 +- 4 files changed, 770 insertions(+), 1 deletion(-) diff --git a/hertzbeat-manager/src/main/resources/define/app-dolphinscheduler.yml b/hertzbeat-manager/src/main/resources/define/app-dolphinscheduler.yml new file mode 100644 index 000000000..48b938ca1 --- /dev/null +++ b/hertzbeat-manager/src/main/resources/define/app-dolphinscheduler.yml @@ -0,0 +1,558 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +category: bigdata +# The monitoring type eg: linux windows tomcat mysql aws... +app: dolphinscheduler +# The monitoring i18n name +name: + zh-CN: Apache DolphinScheduler + en-US: Apache DolphinScheduler +# The description and help of this monitoring type +help: + zh-CN: Hertzbeat 对 Apache DolphinScheduler (支持v3.3.0或更高版本)通用指标进行测量监控。<br>您可以点击 “<i>新建 Apache DolphinScheduler</i>” 并进行配置,或者选择“<i>更多操作</i>”,导入已有配置。 + en-US: Hertzbeat measures and monitors the general metrics of Apache DolphinScheduler (support v3.3.0 or later).<br>You can click on “<i>Create New Apache DolphinScheduler</i>” to configure it, or select “<i>More Actions</i>” to import an existing configuration. +helpLink: + zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/dolphinscheduler + en-US: https://hertzbeat.apache.org/docs/help/dolphinscheduler +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 目标Host + en-US: Target Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + # field-param field key + - field: port + # name-param field display i18n name + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + # required-true or false + required: true + # default value + defaultValue: 12345 + # field-param field key + - field: timeout + # name-param field display i18n name + name: + zh-CN: 查询超时时间 + en-US: Query Timeout + # type-param field type(most mapping the html input type) + type: number + # required-true or false + required: false + # hide param-true or false + hide: true + # default value + defaultValue: 6000 + # field-param field key + - field: ssl + # name-param field display i18n name + name: + zh-CN: 启用HTTPS + en-US: SSL + # type-param field type(boolean mapping the html h tag) + type: boolean + # required-true or false + required: true + - field: token + # name-param field display i18n name + name: + zh-CN: 令牌 + en-US: Token + type: text + limit: 100 + required: true + +# collect metrics config list +metrics: + - name: master + i18n: + zh-CN: Master + en-US: Master + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: host + type: 1 + i18n: + zh-CN: 主机地址 + en-US: Host + - field: port + type: 1 + i18n: + zh-CN: 端口 + en-US: Port + - field: serverStatus + type: 1 + i18n: + zh-CN: 状态 + en-US: Server Status + - field: processId + type: 1 + i18n: + zh-CN: 进程 ID + en-US: Process Id + - field: runningTime + type: 0 + i18n: + zh-CN: 运行时间 + en-US: Running Time + - field: cpuUsage + type: 0 + unit: '%' + i18n: + zh-CN: 处理器使用量 + en-US: CPU Usage + - field: memoryUsage + type: 0 + unit: '%' + i18n: + zh-CN: 内存使用量 + en-US: Memory Usage + - field: diskUsage + type: 0 + unit: '%' + i18n: + zh-CN: 磁盘使用量 + en-US: Disk Usage + - field: jvmCpuUsage + type: 0 + unit: '%' + i18n: + zh-CN: JVM CPU 使用量 + en-US: JVM CPU Usage + - field: jvmMemoryUsage + type: 0 + unit: '%' + i18n: + zh-CN: JVM 内存 使用量 + en-US: JVM Memory Usage + - field: jvmHeapUsed + type: 0 + i18n: + zh-CN: JVM 已使用的堆内存大小 + en-US: JVM Heap Used + - field: jvmNonHeapUsed + type: 0 + i18n: + zh-CN: JVM 已使用的非堆内存大小 + en-US: JVM NonHeap Used + - field: jvmHeapMax + type: 0 + i18n: + zh-CN: JVM 配置的最大堆内存大小 + en-US: JVM Heap Max + - field: jvmNonHeapMax + type: 0 + i18n: + zh-CN: JVM 配置的最大非堆内存大小 + en-US: JVM NonHeap Max + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - $.heartBeatInfo + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - host=json:apply($.heartBeatInfo).host + - port=json:apply($.heartBeatInfo).port + - serverStatus=json:apply($.heartBeatInfo).serverStatus + - processId=json:apply($.heartBeatInfo).processId + - runningTime=(now()-json:apply($.heartBeatInfo).startupTime)/86400000 + - cpuUsage=json:apply($.heartBeatInfo).cpuUsage * 100 + - memoryUsage=json:apply($.heartBeatInfo).memoryUsage * 100 + - diskUsage=json:apply($.heartBeatInfo).diskUsage * 100 + - jvmCpuUsage=json:apply($.heartBeatInfo).jvmCpuUsage + - jvmMemoryUsage=json:apply($.heartBeatInfo).jvmMemoryUsage + - jvmHeapUsed=json:apply($.heartBeatInfo).jvmHeapUsed + - jvmNonHeapUsed=json:apply($.heartBeatInfo).jvmNonHeapUsed + - jvmHeapMax=json:apply($.heartBeatInfo).jvmHeapMax + - jvmNonHeapMax=json:apply($.heartBeatInfo).jvmNonHeapMax + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: /dolphinscheduler/monitor/MASTER + # http method: GET POST PUT DELETE PATCH + method: GET + # if enabled https + ssl: ^_^ssl^_^ + # http request header content + headers: + token: ^_^token^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$.data[*]' + + - name: worker + i18n: + zh-CN: Worker + en-US: Worker + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 1 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: host + type: 1 + i18n: + zh-CN: 主机地址 + en-US: Host + - field: port + type: 1 + i18n: + zh-CN: 端口 + en-US: Port + - field: serverStatus + type: 1 + i18n: + zh-CN: 状态 + en-US: Server Status + - field: processId + type: 1 + i18n: + zh-CN: 进程 ID + en-US: Process Id + - field: runningTime + type: 0 + i18n: + zh-CN: 运行时间 + en-US: Running Time + - field: cpuUsage + type: 0 + unit: '%' + i18n: + zh-CN: 处理器使用量 + en-US: CPU Usage + - field: memoryUsage + type: 0 + unit: '%' + i18n: + zh-CN: 内存使用量 + en-US: Memory Usage + - field: diskUsage + type: 0 + unit: '%' + i18n: + zh-CN: 磁盘使用量 + en-US: Disk Usage + - field: jvmCpuUsage + type: 0 + unit: '%' + i18n: + zh-CN: JVM CPU 使用量 + en-US: JVM CPU Usage + - field: jvmMemoryUsage + type: 0 + unit: '%' + i18n: + zh-CN: JVM 内存 使用量 + en-US: JVM Memory Usage + - field: jvmHeapUsed + type: 0 + i18n: + zh-CN: JVM 已使用的堆内存大小 + en-US: JVM Heap Used + - field: jvmNonHeapUsed + type: 0 + i18n: + zh-CN: JVM 已使用的非堆内存大小 + en-US: JVM NonHeap Used + - field: jvmHeapMax + type: 0 + i18n: + zh-CN: JVM 配置的最大堆内存大小 + en-US: JVM Heap Max + - field: jvmNonHeapMax + type: 0 + i18n: + zh-CN: JVM 配置的最大非堆内存大小 + en-US: JVM NonHeap Max + - field: workerHostWeight + type: 0 + i18n: + zh-CN: 权重 + en-US: Weight + - field: threadPoolUsage + type: 0 + unit: '%' + i18n: + zh-CN: 线程池使用量 + en-US: Thread Pool Usage + - field: workerGroup + type: 1 + i18n: + zh-CN: Worker 组 + en-US: Worker Group + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - $.heartBeatInfo + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - host=json:apply($.heartBeatInfo).host + - port=json:apply($.heartBeatInfo).port + - serverStatus=json:apply($.heartBeatInfo).serverStatus + - processId=json:apply($.heartBeatInfo).processId + - runningTime=(now()-json:apply($.heartBeatInfo).startupTime)/86400000 + - cpuUsage=json:apply($.heartBeatInfo).cpuUsage * 100 + - memoryUsage=json:apply($.heartBeatInfo).memoryUsage * 100 + - diskUsage=json:apply($.heartBeatInfo).diskUsage * 100 + - jvmCpuUsage=json:apply($.heartBeatInfo).jvmCpuUsage + - jvmMemoryUsage=json:apply($.heartBeatInfo).jvmMemoryUsage + - jvmHeapUsed=json:apply($.heartBeatInfo).jvmHeapUsed + - jvmNonHeapUsed=json:apply($.heartBeatInfo).jvmNonHeapUsed + - jvmHeapMax=json:apply($.heartBeatInfo).jvmHeapMax + - jvmNonHeapMax=json:apply($.heartBeatInfo).jvmNonHeapMax + - workerHostWeight=json:apply($.heartBeatInfo).workerHostWeight + - threadPoolUsage=json:apply($.heartBeatInfo).threadPoolUsage + - workerGroup=json:apply($.heartBeatInfo).workerGroup + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: /dolphinscheduler/monitor/WORKER + # http method: GET POST PUT DELETE PATCH + method: GET + # if enabled https + ssl: ^_^ssl^_^ + # http request header content + headers: + token: ^_^token^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$.data[*]' + + - name: alert-server + i18n: + zh-CN: Alert Server + en-US: Alert Server + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: host + type: 1 + i18n: + zh-CN: 主机地址 + en-US: Host + - field: port + type: 1 + i18n: + zh-CN: 端口 + en-US: Port + - field: serverStatus + type: 1 + i18n: + zh-CN: 状态 + en-US: Server Status + - field: processId + type: 1 + i18n: + zh-CN: 进程 ID + en-US: Process Id + - field: runningTime + type: 0 + i18n: + zh-CN: 运行时间 + en-US: Running Time + - field: cpuUsage + type: 0 + unit: '%' + i18n: + zh-CN: 处理器使用量 + en-US: CPU Usage + - field: memoryUsage + type: 0 + unit: '%' + i18n: + zh-CN: 内存使用量 + en-US: Memory Usage + - field: diskUsage + type: 0 + unit: '%' + i18n: + zh-CN: 磁盘使用量 + en-US: Disk Usage + - field: jvmCpuUsage + type: 0 + unit: '%' + i18n: + zh-CN: JVM CPU 使用量 + en-US: JVM CPU Usage + - field: jvmMemoryUsage + type: 0 + unit: '%' + i18n: + zh-CN: JVM 内存 使用量 + en-US: JVM Memory Usage + - field: jvmHeapUsed + type: 0 + i18n: + zh-CN: JVM 已使用的堆内存大小 + en-US: JVM Heap Used + - field: jvmNonHeapUsed + type: 0 + i18n: + zh-CN: JVM 已使用的非堆内存大小 + en-US: JVM NonHeap Used + - field: jvmHeapMax + type: 0 + i18n: + zh-CN: JVM 配置的最大堆内存大小 + en-US: JVM Heap Max + - field: jvmNonHeapMax + type: 0 + i18n: + zh-CN: JVM 配置的最大非堆内存大小 + en-US: JVM NonHeap Max + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - $.heartBeatInfo + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - host=json:apply($.heartBeatInfo).host + - port=json:apply($.heartBeatInfo).port + - serverStatus=json:apply($.heartBeatInfo).serverStatus + - processId=json:apply($.heartBeatInfo).processId + - runningTime=(now()-json:apply($.heartBeatInfo).startupTime)/86400000 + - cpuUsage=json:apply($.heartBeatInfo).cpuUsage * 100 + - memoryUsage=json:apply($.heartBeatInfo).memoryUsage * 100 + - diskUsage=json:apply($.heartBeatInfo).diskUsage * 100 + - jvmCpuUsage=json:apply($.heartBeatInfo).jvmCpuUsage + - jvmMemoryUsage=json:apply($.heartBeatInfo).jvmMemoryUsage + - jvmHeapUsed=json:apply($.heartBeatInfo).jvmHeapUsed + - jvmNonHeapUsed=json:apply($.heartBeatInfo).jvmNonHeapUsed + - jvmHeapMax=json:apply($.heartBeatInfo).jvmHeapMax + - jvmNonHeapMax=json:apply($.heartBeatInfo).jvmNonHeapMax + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: /dolphinscheduler/monitor/ALERT_SERVER + # http method: GET POST PUT DELETE PATCH + method: GET + # if enabled https + ssl: ^_^ssl^_^ + # http request header content + headers: + token: ^_^token^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$.data[*]' + + - name: database + i18n: + zh-CN: 数据库 + en-US: Database + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 2 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field + - field: dbType + type: 1 + i18n: + zh-CN: 数据库类型 + en-US: Database Type + - field: state + type: 1 + i18n: + zh-CN: 状态 + en-US: State + - field: maxConnections + type: 0 + i18n: + zh-CN: 最大连接数 + en-US: Max Connections + - field: threadsConnections + type: 0 + i18n: + zh-CN: 当前连接数 + en-US: Threads Connections + - field: threadsRunningConnections + type: 0 + i18n: + zh-CN: 当前活跃连接数 + en-US: Threads Running Connections + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - dbType + - state + - maxConnections + - threadsConnections + - threadsRunningConnections + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - dbType=dbType + - state=state + - maxConnections=maxConnections + - threadsConnections=threadsConnections + - threadsRunningConnections=threadsRunningConnections + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: /dolphinscheduler/monitor/databases + # http method: GET POST PUT DELETE PATCH + method: GET + # if enabled https + ssl: ^_^ssl^_^ + # http request header content + headers: + token: ^_^token^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: jsonPath + parseScript: '$.data[0]' diff --git a/home/docs/help/dolphinscheduler.md b/home/docs/help/dolphinscheduler.md new file mode 100644 index 000000000..a70aa100e --- /dev/null +++ b/home/docs/help/dolphinscheduler.md @@ -0,0 +1,105 @@ +--- +id: dolphinscheduler +title: Monitoring: Apache DolphinScheduler +sidebar_label: Apache DolphinScheduler +keywords: [ Open Source Monitoring System, Monitor Apache DolphinScheduler ] +--- + +> Collect monitoring metrics for Apache DolphinScheduler. + +## Pre-monitoring operations + +> Support Apache DolphinScheduler version 3.3.0 or later + +You need to create a token in Apache DolphinScheduler. + +Please refer to [Open API](https://dolphinscheduler.apache.org/zh-cn/docs/3.2.2/guide/api/open-api) to create a new token.The main steps are as follows + +1. Log in to the Apache DolphinScheduler system, click "Security", then click "Token manage" on the left, and click "Create token" to create a token. +2. Select the "Expiration time" (Token validity time), select "User" (choose the specified user to perform the API operation), click "Generate token", copy the Token string, and click "Submit". + +## Configuration Parameters + +| Parameter Name | Parameter Help Description | +|---------------------|-----------------------------------------------------------------------------------------------------------------| +| Target Host | The monitored endpoint's IPV4, IPV6, or domain name. Note ⚠️ no protocol header (e.g., https://, http://). | +| Task Name | The name that identifies this monitoring task, which needs to be unique. | +| Port | The monitoring port opened by DolphinScheduler, default value: 12345. | +| SSL | Whether SSL is enabled for connecting to DolphinScheduler. | +| Token | Apache DolphinScheduler token string. | +| Query Timeout | Set the timeout for unresponsive queries, in milliseconds (ms), default 6000 ms. | +| Collection Interval | The interval time for periodic data collection, in seconds; the minimum interval that can be set is 30 seconds. | +| Binding Tags | Used for categorizing and managing monitoring resources. | +| Description Notes | Additional identification and description notes for this monitoring; users can add notes here. | + +## Collected Metrics + +### Metric Set: Master + +| Metric Name | Metric Unit | Metric Help Description | +|----------------|---------------|-------------------------| +| host | None | Host | +| port | None | Port | +| serverStatus | None | Server Status | +| processId | None | Process Id | +| runningTime | Day | Running Time | +| cpuUsage | Percentage(%) | CPU Usage | +| memoryUsage | Percentage(%) | Memory Usage | +| diskUsage | Percentage(%) | Disk Usage | +| jvmCpuUsage | Percentage(%) | JVM CPU Usage | +| jvmMemoryUsage | Percentage(%) | JVM Memory Usage | +| jvmHeapUsed | None | JVM Heap Used | +| jvmNonHeapUsed | None | JVM NonHeap Used | +| jvmHeapMax | None | JVM Heap Max | +| jvmNonHeapMax | None | JVM NonHeap Max | + +### Metric Set: Worker + +| Metric Name | Metric Unit | Metric Help Description | +|------------------|---------------|-------------------------| +| host | None | Host | +| port | None | Port | +| serverStatus | None | Server Status | +| processId | None | Process Id | +| runningTime | Day | Running Time | +| cpuUsage | Percentage(%) | CPU Usage | +| memoryUsage | Percentage(%) | Memory Usage | +| diskUsage | Percentage(%) | Disk Usage | +| jvmCpuUsage | Percentage(%) | JVM CPU Usage | +| jvmMemoryUsage | Percentage(%) | JVM Memory Usage | +| jvmHeapUsed | None | JVM Heap Used | +| jvmNonHeapUsed | None | JVM NonHeap Used | +| jvmHeapMax | None | JVM Heap Max | +| jvmNonHeapMax | None | JVM NonHeap Max | +| workerHostWeight | None | Weight | +| threadPoolUsage | None | Thread Pool Usage | +| workerGroup | None | Worker Group | + +### Metric Set: Alert Server + +| Metric Name | Metric Unit | Metric Help Description | +|----------------|---------------|-------------------------| +| host | None | Host | +| port | None | Port | +| serverStatus | None | Server Status | +| processId | None | Process Id | +| runningTime | Day | Running Time | +| cpuUsage | Percentage(%) | CPU Usage | +| memoryUsage | Percentage(%) | Memory Usage | +| diskUsage | Percentage(%) | Disk Usage | +| jvmCpuUsage | Percentage(%) | JVM CPU Usage | +| jvmMemoryUsage | Percentage(%) | JVM Memory Usage | +| jvmHeapUsed | None | JVM Heap Used | +| jvmNonHeapUsed | None | JVM NonHeap Used | +| jvmHeapMax | None | JVM Heap Max | +| jvmNonHeapMax | None | JVM NonHeap Max | + +### Metric Set: Database + +| Metric Name | Metric Unit | Metric Help Description | +|---------------------------|-------------|-----------------------------| +| dbType | None | Database Type | +| state | None | State | +| maxConnections | None | Max Connections | +| threadsConnections | None | Threads Connections | +| threadsRunningConnections | Day | Threads Running Connections | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dolphinscheduler.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dolphinscheduler.md new file mode 100644 index 000000000..a8a56dc93 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dolphinscheduler.md @@ -0,0 +1,105 @@ +--- +id: dolphinscheduler +title: 监控:Apache DolphinScheduler +sidebar_label: Apache DolphinScheduler +keywords: [ 开源监控系统, 监控 Apache DolphinScheduler ] +--- + +> 对 Apache DolphinScheduler 指标进行采集监控。 + +## 监控前操作 + +> 支持 Apache DolphinScheduler v3.3.0 或更高版本 + +您需在 Apache DolphinScheduler 中创建令牌。 + +可参考 [API 调用](https://dolphinscheduler.apache.org/zh-cn/docs/3.2.2/guide/api/open-api) 创建一个新令牌,具体步骤如下: + +1. 登录 Apache DolphinScheduler 系统,点击 "安全中心",再点击左侧的 "令牌管理",点击 "令牌管理" 创建令牌。 +2. 选择 "失效时间" (Token 有效期),选择 "用户" (以指定的用户执行接口操作),点击 "生成令牌" ,拷贝令牌字符串,然后点击 "提交" 。 + +## 配置参数 + +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | DolphinScheduler开放的监控端口,默认值:12345。 | +| 启用HTTPS | 是否启用HTTPS。 | +| 令牌 | DolphinScheduler 的令牌字符串。 | +| 查询超时时间 | 设置查询未响应数据时的超时时间,单位ms毫秒,默认6000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +## 采集指标 + +### 指标集合:Master + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|--------|-----------------| +| host | 无 | 主机地址 | +| port | 无 | 端口 | +| serverStatus | 无 | 状态 | +| processId | 无 | 进程 ID | +| runningTime | 天 | 运行时间 | +| cpuUsage | 百分比(%) | 处理器使用量 | +| memoryUsage | 百分比(%) | 内存使用量 | +| diskUsage | 百分比(%) | 磁盘可用容量 | +| jvmCpuUsage | 百分比(%) | JVM CPU 使用量 | +| jvmMemoryUsage | 百分比(%) | JVM 内存 使用量 | +| jvmHeapUsed | 无 | JVM 已使用的堆内存大小 | +| jvmNonHeapUsed | 无 | JVM 已使用的非堆内存大小 | +| jvmHeapMax | 无 | JVM 配置的最大堆内存大小 | +| jvmNonHeapMax | 无 | JVM 配置的最大非堆内存大小 | + +### 指标集合:Worker + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|--------|-----------------| +| host | 无 | 主机地址 | +| port | 无 | 端口 | +| serverStatus | 无 | 状态 | +| processId | 无 | 进程 ID | +| runningTime | 天 | 运行时间 | +| cpuUsage | 百分比(%) | CPU使用率 | +| memoryUsage | 百分比(%) | 内存使用率 | +| diskUsage | 百分比(%) | 磁盘可用容量 | +| jvmCpuUsage | 百分比(%) | JVM CPU 使用量 | +| jvmMemoryUsage | 百分比(%) | JVM 内存 使用量 | +| jvmHeapUsed | 无 | JVM 已使用的堆内存大小 | +| jvmNonHeapUsed | 无 | JVM 已使用的非堆内存大小 | +| jvmHeapMax | 无 | JVM 配置的最大堆内存大小 | +| jvmNonHeapMax | 无 | JVM 配置的最大非堆内存大小 | +| workerHostWeight | 无 | 权重 | +| threadPoolUsage | 无 | 线程池使用量 | +| workerGroup | 无 | Worker 组 | + +### 指标集合:Alert Server + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|--------|-----------------| +| host | 无 | 主机地址 | +| port | 无 | 端口 | +| serverStatus | 无 | 状态 | +| processId | 无 | 进程 ID | +| runningTime | 天 | 运行时间 | +| cpuUsage | 百分比(%) | 处理器使用量 | +| memoryUsage | 百分比(%) | 内存使用量 | +| diskUsage | 百分比(%) | 磁盘可用容量 | +| jvmCpuUsage | 百分比(%) | JVM CPU 使用量 | +| jvmMemoryUsage | 百分比(%) | JVM 内存 使用量 | +| jvmHeapUsed | 无 | JVM 已使用的堆内存大小 | +| jvmNonHeapUsed | 无 | JVM 已使用的非堆内存大小 | +| jvmHeapMax | 无 | JVM 配置的最大堆内存大小 | +| jvmNonHeapMax | 无 | JVM 配置的最大非堆内存大小 | + +### 指标:数据库 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------|--------|-----------| +| dbType | 无 | 数据库类型 | +| state | 无 | 状态 | +| maxConnections | 无 | 最大连接数 | +| threadsConnections | 无 | 当前连接数 | +| threadsRunningConnections | 天 | 当前活跃连接数 | diff --git a/home/sidebars.json b/home/sidebars.json index c06acf856..205c03cf8 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -241,7 +241,8 @@ "help/presto", "help/seatunnel", "help/spark", - "help/yarn" + "help/yarn", + "help/dolphinscheduler" ] }, { --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@hertzbeat.apache.org For additional commands, e-mail: notifications-h...@hertzbeat.apache.org