This is an automated email from the ASF dual-hosted git repository.
gongchao 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 d3209b645 [feature] add influxdb metrics monitoring (#1730)
d3209b645 is described below
commit d3209b645f3e5cc86ed8dd0b7d4b648e89389abe
Author: 铁甲小宝 <[email protected]>
AuthorDate: Sat Apr 27 15:16:48 2024 +0800
[feature] add influxdb metrics monitoring (#1730)
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/help/influxdb.md | 67 +++
.../version-v1.1.x/help/influxdb.md | 67 +++
.../current/help/influxdb.md | 68 +++
home/sidebars.json | 571 +++++++++++----------
manager/src/main/resources/define/app-influxdb.yml | 393 ++++++++++++++
5 files changed, 881 insertions(+), 285 deletions(-)
diff --git a/home/docs/help/influxdb.md b/home/docs/help/influxdb.md
new file mode 100644
index 000000000..8aaef6ae6
--- /dev/null
+++ b/home/docs/help/influxdb.md
@@ -0,0 +1,67 @@
+---
+id: influxdb
+title: Monitoring: InfluxDB Database Monitoring
+sidebar_label: InfluxDB Database
+keywords: [open source monitoring system, open source database monitoring,
InfluxDB database monitoring]
+---
+
+### Configuration Parameters
+
+| Parameter Name | Parameter Description
|
+| -------------- | -------------------------------------------------------- |
+| Monitor Host | The IPv4, IPv6, or domain name of the target being
monitored. Note⚠️: Do not include the protocol header (e.g., https://,
http://). |
+| Task Name | A unique identifier for this monitoring task.
|
+| Port | The port on which the database is exposed. Default is 8086.
|
+| URL | The database connection URL, usually constructed from the
host. No need to add it separately. |
+| Collection Interval | The interval at which data is collected during
monitoring, in seconds. The minimum interval that can be set is 30 seconds.
|
+| Probe Enabled | Whether to perform a probe check for monitoring
availability before adding or modifying the monitoring task.
|
+| Description | Additional notes and remarks about this monitoring task.
Users can provide information and descriptions here. |
+
+### Collected Metrics
+
+#### Metric Set: influxdb_info
+
+| Metric Name | Metric Unit | Metric Description |
+|------------| ----------- |--------|
+| build_date | N/A | Creation date |
+| os | N/A | Operating system |
+| cpus | N/A | CPUs |
+| version | N/A | Version number |
+
+#### Metric Set: http_api_request_duration_seconds
+
+| Metric Name | Metric Unit | Metric Description |
+|---------------|------|---------|
+| handler | N/A | Handler |
+| path | N/A | Path |
+| response_code | N/A | Response code |
+| method | N/A | Request method |
+| user_agent | N/A | User agent |
+| status | N/A | Status |
+
+#### Metric Set: storage_compactions_queued
+
+| Metric Name | Metric Unit | Metric Description
|
+|---------------------------------|------|------------|
+| bucket | N/A | Storage bucket |
+| engine | N/A | Engine type |
+| id | N/A | Identifier |
+| level | N/A | Level |
+| path | N/A | Data file path |
+
+
+#### Metric Set: http_write_request_bytes
+
+| Metric Name | Metric Unit | Metric Description |
+| ----------- |------|--------|
+| endpoint | N/A | Endpoint |
+| org_id | N/A | Organization identifier |
+| status | N/A | Status |
+
+#### Metric Set: qc_requests_total
+
+| Metric Name | Metric Unit | Metric Description |
+| ----------- |------|--------|
+| result | N/A | Result |
+| org | N/A | Organization identifier |
+
diff --git
a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/influxdb.md
b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/influxdb.md
new file mode 100644
index 000000000..8aaef6ae6
--- /dev/null
+++
b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/influxdb.md
@@ -0,0 +1,67 @@
+---
+id: influxdb
+title: Monitoring: InfluxDB Database Monitoring
+sidebar_label: InfluxDB Database
+keywords: [open source monitoring system, open source database monitoring,
InfluxDB database monitoring]
+---
+
+### Configuration Parameters
+
+| Parameter Name | Parameter Description
|
+| -------------- | -------------------------------------------------------- |
+| Monitor Host | The IPv4, IPv6, or domain name of the target being
monitored. Note⚠️: Do not include the protocol header (e.g., https://,
http://). |
+| Task Name | A unique identifier for this monitoring task.
|
+| Port | The port on which the database is exposed. Default is 8086.
|
+| URL | The database connection URL, usually constructed from the
host. No need to add it separately. |
+| Collection Interval | The interval at which data is collected during
monitoring, in seconds. The minimum interval that can be set is 30 seconds.
|
+| Probe Enabled | Whether to perform a probe check for monitoring
availability before adding or modifying the monitoring task.
|
+| Description | Additional notes and remarks about this monitoring task.
Users can provide information and descriptions here. |
+
+### Collected Metrics
+
+#### Metric Set: influxdb_info
+
+| Metric Name | Metric Unit | Metric Description |
+|------------| ----------- |--------|
+| build_date | N/A | Creation date |
+| os | N/A | Operating system |
+| cpus | N/A | CPUs |
+| version | N/A | Version number |
+
+#### Metric Set: http_api_request_duration_seconds
+
+| Metric Name | Metric Unit | Metric Description |
+|---------------|------|---------|
+| handler | N/A | Handler |
+| path | N/A | Path |
+| response_code | N/A | Response code |
+| method | N/A | Request method |
+| user_agent | N/A | User agent |
+| status | N/A | Status |
+
+#### Metric Set: storage_compactions_queued
+
+| Metric Name | Metric Unit | Metric Description
|
+|---------------------------------|------|------------|
+| bucket | N/A | Storage bucket |
+| engine | N/A | Engine type |
+| id | N/A | Identifier |
+| level | N/A | Level |
+| path | N/A | Data file path |
+
+
+#### Metric Set: http_write_request_bytes
+
+| Metric Name | Metric Unit | Metric Description |
+| ----------- |------|--------|
+| endpoint | N/A | Endpoint |
+| org_id | N/A | Organization identifier |
+| status | N/A | Status |
+
+#### Metric Set: qc_requests_total
+
+| Metric Name | Metric Unit | Metric Description |
+| ----------- |------|--------|
+| result | N/A | Result |
+| org | N/A | Organization identifier |
+
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md
new file mode 100644
index 000000000..1881d79f4
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md
@@ -0,0 +1,68 @@
+---
+id: influxdb
+title: 监控：InfluxDB 数据库监控
+sidebar_label: InfluxDB 数据库
+keywords: [开源监控系统, 开源数据库监控, InfluxDB 数据库监控]
+---
+
+
+### 配置参数
+
+| 参数名称 | 参数帮助描述 |
+| ----------- |------------------------------------------------------|
+| 监控Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 端口 | 数据库对外提供的端口，默认为8086。 |
+| URL | 数据库连接URL,一般是由host拼接，不需要添加 |
+| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
+| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
+
+### 采集指标
+
+#### 指标集合：influxdb 基本信息
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|------------| ----------- |--------|
+| build_date | 无 | 创建日期 |
+| os | 无 | 操作系统 |
+| cpus | 无 | cpus |
+| version | 无 | 版本号 |
+
+#### 指标集合：http 响应时间
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|---------------|------|---------|
+| handler | 无 | handler |
+| path | 无 | 路径 |
+| response_code | 无 | 返回code |
+| method | 无 | 请求方法 |
+| user_agent | 无 | 用户代理 |
+| status | 无 | 状态 |
+
+#### 指标集合：正在排队的 TSM 数
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+|---------------------------------|------|------------|
+| bucket | 无 | 存储桶 |
+| engine | 无 | 引擎类型 |
+| id | 无 | 标识符 |
+| level | 无 | 级别 |
+| path | 无 | 数据文件路径 |
+
+
+#### 指标集合：HTTP写入请求的字节数量
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ----------- |------|--------|
+| endpoint | 无 | 终点 |
+| org_id | 无 | 组织标识符 |
+| status | 无 | 状态 |
+
+#### 指标集合：质量控制请求总数
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ----------- |------|--------|
+| result | 无 | 结果 |
+| org | 无 | 组织标识符 |
+
diff --git a/home/sidebars.json b/home/sidebars.json
index 709aa0741..17c71c455 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -1,285 +1,286 @@
-{
- "docs": [
- {
- "type": "category",
- "label": "quickstart",
- "items": [
- "introduce",
- "start/quickstart",
- "start/docker-deploy",
- "start/package-deploy",
- "start/rainbond-deploy",
- {
- "type": "link",
- "label": "Install via Helm",
- "href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
- },
- "start/upgrade",
- "start/victoria-metrics-init",
- "start/iotdb-init",
- "start/tdengine-init",
- "start/greptime-init",
- "start/influxdb-init",
- "start/mysql-change",
- "start/postgresql-change",
- "start/account-modify",
- "start/custom-config",
- "start/ssl-cert-practice"
- ]
- },
- {
- "type": "category",
- "label": "custom",
- "items": [
- "advanced/extend-point",
- "advanced/extend-tutorial",
- {
- "type": "category",
- "label": "http",
- "items": [
- "advanced/extend-http",
- "advanced/extend-http-default",
- "advanced/extend-http-jsonpath",
- "advanced/extend-http-example-hertzbeat",
- "advanced/extend-http-example-token"
- ]
- },
- {
- "type": "category",
- "label": "jdbc",
- "items": [
- "advanced/extend-jdbc"
- ]
- },
- {
- "type": "category",
- "label": "ssh",
- "items": [
- "advanced/extend-ssh"
- ]
- },
- {
- "type": "category",
- "label": "jmx",
- "items": [
- "advanced/extend-jmx"
- ]
- },
- {
- "type": "category",
- "label": "snmp",
- "items": [
- "advanced/extend-snmp"
- ]
- },
- {
- "type": "category",
- "label": "push",
- "items": [
- "advanced/extend-push"
- ]
- }
- ]
- },
- {
- "type": "doc",
- "id": "template"
- },
- {
- "type": "category",
- "label": "Community",
- "items": [
- "community/contact",
- {
- "type": "category",
- "label": "contribution",
- "items": [
- "community/mailing_lists",
- "community/become_committer",
- "community/become_pmc_member",
- "community/new_committer_process",
- "community/new_pmc_ember_process"
- ]
- },
- {
- "type": "category",
- "label": "submit",
- "items": [
- "community/document",
- "community/submit_code",
- "community/code_style_and_quality_guide"
- ]
- },
- {
- "type": "category",
- "label": "release",
- "items": [
- "community/how_to_release",
- "community/how_to_verify_release"
- ]
- }
- ]
- },
- {
- "type": "category",
- "label": "help",
- "items": [
- "help/guide",
- "help/prometheus",
- {
- "type": "category",
- "label": "service",
- "items": [
- "help/website",
- "help/api",
- "help/ping",
- "help/port",
- "help/udp_port",
- "help/fullsite",
- "help/ssl_cert",
- "help/nginx",
- "help/pop3",
- "help/smtp",
- "help/ntp",
- "help/dns",
- "help/ftp"
- ]
- },
- {
- "type": "category",
- "label": "program",
- "items": [
- "help/process",
- "help/jvm",
- "help/springboot2",
- "help/springboot3",
- "help/dynamic_tp"
- ]
- },
- {
- "type": "category",
- "label": "database",
- "items": [
- "help/mysql",
- "help/mariadb",
- "help/postgresql",
- "help/sqlserver",
- "help/oracle",
- "help/dm",
- "help/opengauss",
- "help/nebulaGraph",
- "help/tidb",
- "help/mongodb"
-
- ]
- },
- {
- "type": "category",
- "label": "cache",
- "items": [
- "help/redis",
- "help/memcached"
- ]
- },
- {
- "type": "category",
- "label": "os",
- "items": [
- "help/linux",
- "help/windows",
- "help/ubuntu",
- "help/debian",
- "help/centos"
- ]
- },
- {
- "type": "category",
- "label": "mid",
- "items": [
- "help/zookeeper",
- "help/shenyu",
- "help/rabbitmq",
- "help/activemq",
- "help/spring_gateway",
- "help/nacos"
- ]
- },
- {
- "type": "category",
- "label": "bigdata",
- "items": [
- "help/spark",
- "help/doris_be",
- "help/doris_fe",
- "help/hadoop",
- "help/hbase_master",
- "help/hbase_regionserver",
- "help/iotdb",
- "help/hive",
- "help/airflow",
- "help/clickhouse",
- "help/elasticsearch"
- ]
- },
- {
- "type": "category",
- "label": "webserver",
- "items": [
- "help/tomcat",
- "help/jetty"
- ]
- },
- {
- "type": "category",
- "label": "cloud-native",
- "items": [
- "help/docker",
- "help/kubernetes"
- ]
- },
- {
- "type": "category",
- "label": "threshold",
- "items": [
- "help/alert_threshold",
- "help/alert_threshold_expr"
- ]
- },
- {
- "type": "category",
- "label": "notice",
- "items": [
- "help/alert_email",
- "help/alert_webhook",
- "help/alert_discord",
- "help/alert_slack",
- "help/alert_telegram",
- "help/alert_wework",
- "help/alert_dingtalk",
- "help/alert_feishu",
- "help/alert_console",
- "help/alert_enterprise_wechat_app",
- "help/alert_smn"
- ]
- },
- {
- "type": "category",
- "label": "Network",
- "items": [
- "help/huawei_switch"
- ]
- },
- "help/issue"
- ]
- },
- {
- "type": "category",
- "label": "Others",
- "items": [
- "others/contributing",
- "others/resource"
- ]
- }
- ]
-}
-
+{
+ "docs": [
+ {
+ "type": "category",
+ "label": "quickstart",
+ "items": [
+ "introduce",
+ "start/quickstart",
+ "start/docker-deploy",
+ "start/package-deploy",
+ "start/rainbond-deploy",
+ {
+ "type": "link",
+ "label": "Install via Helm",
+ "href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
+ },
+ "start/upgrade",
+ "start/victoria-metrics-init",
+ "start/iotdb-init",
+ "start/tdengine-init",
+ "start/greptime-init",
+ "start/influxdb-init",
+ "start/mysql-change",
+ "start/postgresql-change",
+ "start/account-modify",
+ "start/custom-config",
+ "start/ssl-cert-practice"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "custom",
+ "items": [
+ "advanced/extend-point",
+ "advanced/extend-tutorial",
+ {
+ "type": "category",
+ "label": "http",
+ "items": [
+ "advanced/extend-http",
+ "advanced/extend-http-default",
+ "advanced/extend-http-jsonpath",
+ "advanced/extend-http-example-hertzbeat",
+ "advanced/extend-http-example-token"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "jdbc",
+ "items": [
+ "advanced/extend-jdbc"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "ssh",
+ "items": [
+ "advanced/extend-ssh"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "jmx",
+ "items": [
+ "advanced/extend-jmx"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "snmp",
+ "items": [
+ "advanced/extend-snmp"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "push",
+ "items": [
+ "advanced/extend-push"
+ ]
+ }
+ ]
+ },
+ {
+ "type": "doc",
+ "id": "template"
+ },
+ {
+ "type": "category",
+ "label": "Community",
+ "items": [
+ "community/contact",
+ {
+ "type": "category",
+ "label": "contribution",
+ "items": [
+ "community/mailing_lists",
+ "community/become_committer",
+ "community/become_pmc_member",
+ "community/new_committer_process",
+ "community/new_pmc_ember_process"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "submit",
+ "items": [
+ "community/document",
+ "community/submit_code",
+ "community/code_style_and_quality_guide"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "release",
+ "items": [
+ "community/how_to_release",
+ "community/how_to_verify_release"
+ ]
+ }
+ ]
+ },
+ {
+ "type": "category",
+ "label": "help",
+ "items": [
+ "help/guide",
+ "help/prometheus",
+ {
+ "type": "category",
+ "label": "service",
+ "items": [
+ "help/website",
+ "help/api",
+ "help/ping",
+ "help/port",
+ "help/udp_port",
+ "help/fullsite",
+ "help/ssl_cert",
+ "help/nginx",
+ "help/pop3",
+ "help/smtp",
+ "help/ntp",
+ "help/dns",
+ "help/ftp"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "program",
+ "items": [
+ "help/process",
+ "help/jvm",
+ "help/springboot2",
+ "help/springboot3",
+ "help/dynamic_tp"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "database",
+ "items": [
+ "help/mysql",
+ "help/mariadb",
+ "help/postgresql",
+ "help/sqlserver",
+ "help/oracle",
+ "help/dm",
+ "help/opengauss",
+ "help/nebulaGraph",
+ "help/tidb",
+ "help/mongodb"
+
+ ]
+ },
+ {
+ "type": "category",
+ "label": "cache",
+ "items": [
+ "help/redis",
+ "help/memcached"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "os",
+ "items": [
+ "help/linux",
+ "help/windows",
+ "help/ubuntu",
+ "help/debian",
+ "help/centos"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "mid",
+ "items": [
+ "help/zookeeper",
+ "help/shenyu",
+ "help/rabbitmq",
+ "help/activemq",
+ "help/spring_gateway",
+ "help/nacos"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "bigdata",
+ "items": [
+ "help/spark",
+ "help/doris_be",
+ "help/doris_fe",
+ "help/hadoop",
+ "help/hbase_master",
+ "help/hbase_regionserver",
+ "help/iotdb",
+ "help/hive",
+ "help/airflow",
+ "help/clickhouse",
+ "help/elasticsearch",
+ "help/influxdb"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "webserver",
+ "items": [
+ "help/tomcat",
+ "help/jetty"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "cloud-native",
+ "items": [
+ "help/docker",
+ "help/kubernetes"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "threshold",
+ "items": [
+ "help/alert_threshold",
+ "help/alert_threshold_expr"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "notice",
+ "items": [
+ "help/alert_email",
+ "help/alert_webhook",
+ "help/alert_discord",
+ "help/alert_slack",
+ "help/alert_telegram",
+ "help/alert_wework",
+ "help/alert_dingtalk",
+ "help/alert_feishu",
+ "help/alert_console",
+ "help/alert_enterprise_wechat_app",
+ "help/alert_smn"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Network",
+ "items": [
+ "help/huawei_switch"
+ ]
+ },
+ "help/issue"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "Others",
+ "items": [
+ "others/contributing",
+ "others/resource"
+ ]
+ }
+ ]
+}
+
diff --git a/manager/src/main/resources/define/app-influxdb.yml
b/manager/src/main/resources/define/app-influxdb.yml
new file mode 100644
index 000000000..1c3b7fe8b
--- /dev/null
+++ b/manager/src/main/resources/define/app-influxdb.yml
@@ -0,0 +1,393 @@
+# 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
+# 监控类型所属类别：service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据
mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等
+category: bigdata
+# The monitoring type eg: linux windows tomcat mysql aws...
+# 监控类型 eg: linux windows tomcat mysql aws...
+app: influxDB
+# The monitoring i18n name
+# 监控类型国际化名称
+name:
+ zh-CN: InfluxDB
+ en-US: InfluxDB
+# The description and help of this monitoring type
+# 监控类型的帮助描述信息
+help:
+ zh-CN: HertzBeat 对 InfluxDB 时序数据库进行监控。<br><span class='help_module_span'><a
class='help_module_content'
href='https://docs.influxdata.com/platform/monitoring/influxdata-platform/tools/measurements-internal'>点击查看开启步骤</a>。</span>
+ en-US: HertzBeat monitors the InfluxDB time series database. <br><span
class='help_module_span'><a class='help_module_content'
href='https://docs.influxdata.com/platform/monitoring/influxdata-platform/tools/measurements-internal
'>Click to view the activation steps</a>. </span>
+ zh-TW: HertzBeat 對 InfluxDB 時序資料庫進行監控。<br><span class='help_module_span'><a
class='help_module_content'
href='https://docs.influxdata.com/platform/monitoring/influxdata-platform/tools/measurements-internal'>點擊查看開啓步驟</a>。</span>
+helpLink:
+ zh-CN: https://hertzbeat.com/zh-cn/docs/help/influxdb/
+ en-US: https://hertzbeat.com/docs/help/influxdb/
+# 监控所需输入参数定义(根据定义渲染页面UI)
+# Input params define for monitoring(render web ui by the definition)
+params:
+ # field-param field key
+ # field-变量字段标识符
+ - field: host
+ # name-param field display i18n name
+ # name-参数字段显示名称
+ name:
+ zh-CN: 目标Host
+ en-US: Target Host
+ # type-param field type(most mapping the html input type)
+ # type-字段类型,样式(大部分映射input标签type属性)
+ type: host
+ # required-true or false
+ # required-是否是必输项 true-必填 false-可选
+ required: true
+ - field: port
+ name:
+ zh-CN: 端口
+ en-US: Port
+ # type-param field type(most mapping the html input type)
+ # type-字段类型,样式(大部分映射input标签type属性)
+ type: number
+ # when type is number, range is required
+ # 当type为number时,用range表示范围
+ range: '[0,65535]'
+ # default value
+ defaultValue: 8086
+ required: true
+ - field: timeout
+ name:
+ zh-CN: 查询超时时间
+ en-US: Query Timeout
+ type: number
+ required: false
+ # hide param-true or false
+ # 是否隐藏字段 true or false
+ hide: true
+ defaultValue: 6000
+
+# collect metrics config list
+# 采集指标配置列表
+metrics:
+ # metrics - cluster_node_status
+ # 监控指标 - cluster_node_status
+
+ - name: influxdb_info
+ i18n:
+ zh-CN: influxdb 基本信息
+ en-US: influxdb_info
+ priority: 0
+ fields:
+ - field: build_date
+ i18n:
+ zh-CN: 创建日期
+ en-US: build_date
+ type: 1
+ label: true
+ - field: os
+ i18n:
+ zh-CN: 操作系统
+ en-US: os
+ type: 1
+ - field: cpus
+ i18n:
+ zh-CN: cpus
+ en-US: cpus
+ type: 1
+ - field: version
+ i18n:
+ zh-CN: 版本
+ en-US: version
+ type: 1
+ aliasFields:
+ - build_date
+ - os
+ - cpus
+ - version
+ calculates:
+ - build_date=build_date
+ - os=os
+ - cpus=cpus
+ - version=version
+ protocol: http
+ http:
+ host: ^_^host^_^
+ port: ^_^port^_^
+ url: '/metrics'
+ timeout: ^_^timeout^_^
+ method: GET
+ parseType: prometheus
+
+ - name: http_api_request_duration_seconds
+ i18n:
+ zh-CN: http 响应时间
+ en-US: http_api_request_duration_seconds
+ # 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
+ # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集
+ # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度
+ 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-指标名称, type-指标类型(0-number数字,1-string字符串),
unit-指标单位('%','ms','MB'), label-是否是指标标签字段
+ - field: handler
+ i18n:
+ zh-CN: handler
+ en-US: handler
+ type: 1
+ - field: path
+ i18n:
+ zh-CN: 路径
+ en-US: path
+ type: 1
+ - field: response_code
+ i18n:
+ zh-CN: 返回 code
+ en-US: response_code
+ type: 1
+ - field: method
+ i18n:
+ zh-CN: 方法
+ en-US: method
+ type: 1
+ - field: user_agent
+ i18n:
+ zh-CN: 用户代理
+ en-US: user_agent
+ type: 1
+ - field: status
+ i18n:
+ zh-CN: 状态
+ en-US: status
+ type: 1
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
+ aliasFields:
+ - handler
+ - path
+ - response_code
+ - method
+ - user_agent
+ - status
+ # mapping and conversion expressions, use these and aliasField above to
calculate metrics value
+ # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+ # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
+ calculates:
+ - handler=handler
+ - path=path
+ - response_code=response_code
+ - method=method
+ - user_agent=user_agent
+ - status=status
+ # 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: '/metrics'
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH
+ method: GET
+ # http response data parse type: default-hertzbeat rule,
jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus
exporter rule
+ # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控,
prometheus-Prometheus数据规则
+ parseType: prometheus
+
+ - name: storage_compactions_queued
+ i18n:
+ zh-CN: 正在排队的 TSM 数
+ en-US: storage_compactions_queued
+ # 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
+ # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集
+ # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度
+ 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-指标名称, type-指标类型(0-number数字,1-string字符串),
unit-指标单位('%','ms','MB'), label-是否是指标标签字段
+ - field: bucket
+ i18n:
+ zh-CN: 存储桶
+ en-US: bucket
+ type: 1
+ - field: engine
+ i18n:
+ zh-CN: 引擎类型
+ en-US: engine
+ type: 1
+ - field: id
+ i18n:
+ zh-CN: 标识符
+ en-US: id
+ type: 1
+ - field: level
+ i18n:
+ zh-CN: 级别
+ en-US: level
+ type: 1
+ - field: path
+ i18n:
+ zh-CN: 数据文件路径
+ en-US: path
+ type: 1
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
+ aliasFields:
+ - bucket
+ - engine
+ - id
+ - level
+ - path
+ # mapping and conversion expressions, use these and aliasField above to
calculate metrics value
+ # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+ # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
+ calculates:
+ - bucket=bucket
+ - engine=engine
+ - id=id
+ - level=level
+ - path=path
+ # 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: '/metrics'
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH
+ method: GET
+ # http response data parse type: default-hertzbeat rule,
jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus
exporter rule
+ # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控,
prometheus-Prometheus数据规则
+ parseType: prometheus
+
+ - name: http_write_request_bytes
+ i18n:
+ zh-CN: HTTP写入请求的字节数量
+ en-US: http_write_request_bytes
+ # 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
+ # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集
+ # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度
+ priority: 3
+ # 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-指标名称, type-指标类型(0-number数字,1-string字符串),
unit-指标单位('%','ms','MB'), label-是否是指标标签字段
+ - field: endpoint
+ i18n:
+ zh-CN: 终点
+ en-US: endpoint
+ type: 1
+ - field: org_id
+ i18n:
+ zh-CN: 组织标识符
+ en-US: org_id
+ type: 1
+ - field: status
+ i18n:
+ zh-CN: 状态
+ en-US: status
+ type: 1
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
+ aliasFields:
+ - endpoint
+ - org_id
+ - status
+ # mapping and conversion expressions, use these and aliasField above to
calculate metrics value
+ # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+ # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
+ calculates:
+ - endpoint=endpoint
+ - org_id=org_id
+ - status=status
+ # 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: '/metrics'
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH
+ method: GET
+ # http response data parse type: default-hertzbeat rule,
jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus
exporter rule
+ # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控,
prometheus-Prometheus数据规则
+ parseType: prometheus
+
+ - name: qc_requests_total
+ i18n:
+ zh-CN: 质量控制请求总数
+ en-US: qc_requests_total
+ # 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
+ # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集
+ # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度
+ priority: 3
+ # 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-指标名称, type-指标类型(0-number数字,1-string字符串),
unit-指标单位('%','ms','MB'), label-是否是指标标签字段
+ - field: result
+ i18n:
+ zh-CN: 结果
+ en-US: result
+ type: 1
+ - field: org
+ i18n:
+ zh-CN: 组织标识符
+ en-US: org
+ type: 1
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
+ aliasFields:
+ - result
+ - org
+ # mapping and conversion expressions, use these and aliasField above to
calculate metrics value
+ # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+ # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
+ calculates:
+ - result=result
+ - org=org
+ # 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: '/metrics'
+ timeout: ^_^timeout^_^
+ # http method: GET POST PUT DELETE PATCH
+ method: GET
+ # http response data parse type: default-hertzbeat rule,
jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus
exporter rule
+ # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控,
prometheus-Prometheus数据规则
+ parseType: prometheus
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
