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 9263727f8 [feature] add apache hugegraph monitor (#1972)
9263727f8 is described below
commit 9263727f8f9074ce3e28f8de55a0c51fc8d08c22
Author: Jast <[email protected]>
AuthorDate: Mon May 13 11:07:25 2024 +0800
[feature] add apache hugegraph monitor (#1972)
Co-authored-by: zhangshenghang <[email protected]>
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/help/hugegraph.md | 150 ++++
.../current/help/hugegraph.md | 146 ++++
home/sidebars.json | 3 +-
manager/src/main/resources/define/hugegraph.yml | 889 +++++++++++++++++++++
4 files changed, 1187 insertions(+), 1 deletion(-)
diff --git a/home/docs/help/hugegraph.md b/home/docs/help/hugegraph.md
new file mode 100644
index 000000000..4fca13f4e
--- /dev/null
+++ b/home/docs/help/hugegraph.md
@@ -0,0 +1,150 @@
+---
+id: hugegraph
+title: Monitoring HugeGraph Monitoring
+sidebar_label: Apache HugeGraph
+keywords: [Open Source Monitoring System, Open Source Database Monitoring,
HugeGraph Monitoring]
+---
+> Collect and monitor the general performance metrics of HugeGraph
+
+**Protocol used: HTTP**
+
+## Pre-monitoring Operations
+
+Check the `rest-server.properties` file to obtain the value of the
`restserver_port` configuration item, which is used for monitoring.
+
+## Configuration Parameters
+
+
+| Parameter Name | Parameter Description
|
+|------------------|--------------------------------------------------------|
+| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint.
Note ⚠️ Do not include protocol headers (eg: https://, http://). |
+| Port | Port number of the HugeGraph restserver, default is 8080.
i.e., the value of the `restserver_port` parameter |
+| Enable SSL | Enable SSL usage
|
+| Base Path | Base path, default is: /metrics, usually does not need to
be modified |
+| Task Name | Identifies the name of this monitoring, ensuring
uniqueness. |
+| Collection Interval | Interval for periodically collecting data for
monitoring, in seconds, with a minimum interval of 30 seconds
|
+| Probe Enabled | Whether to probe before adding new monitoring, only
continue with add/modify operations if the probe is successful
|
+| Description | Additional identification and description of this
monitoring, users can add information here |
+
+### Metrics Collection
+
+#### Metric Set: gauges
+
+| Metric Name | Metric Unit | Metric Description
|
+| ------------------------------------ | -------- |
--------------------------------- |
+| edge-hugegraph-capacity | NONE | Indicates the capacity
limit of edges in the current graph |
+| edge-hugegraph-expire | NONE | Indicates the expiration
time of edge data |
+| edge-hugegraph-hits | NONE | Indicates the number of
hits in the edge data cache |
+| edge-hugegraph-miss | NONE | Indicates the number of
misses in the edge data cache |
+| edge-hugegraph-size | NONE | Indicates the number of
edges in the current graph |
+| instances | NONE | Indicates the number of
currently running HugeGraph instances|
+| schema-id-hugegraph-capacity | NONE | Indicates the capacity
limit of schema IDs in the graph |
+| schema-id-hugegraph-expire | NONE | Indicates the expiration
time of schema ID data |
+| schema-id-hugegraph-hits | NONE | Indicates the number of
hits in the schema ID data cache|
+| schema-id-hugegraph-miss | NONE | Indicates the number of
misses in the schema ID data cache|
+| schema-id-hugegraph-size | NONE | Indicates the number of
schema IDs in the current graph |
+| schema-name-hugegraph-capacity | NONE | Indicates the capacity
limit of schema names in the graph |
+| schema-name-hugegraph-expire | NONE | Indicates the expiration
time of schema name data |
+| schema-name-hugegraph-hits | NONE | Indicates the number of
hits in the schema name data cache|
+| schema-name-hugegraph-miss | NONE | Indicates the number of
misses in the schema name data cache|
+| schema-name-hugegraph-size | NONE | Indicates the number of
schema names in the current graph |
+| token-hugegraph-capacity | NONE | Indicates the capacity
limit of tokens in the graph |
+| token-hugegraph-expire | NONE | Indicates the expiration
time of token data |
+| token-hugegraph-hits | NONE | Indicates the number of
hits in the token data cache |
+| token-hugegraph-miss | NONE | Indicates the number of
misses in the token data cache |
+| token-hugegraph-size | NONE | Indicates the number of
tokens in the current graph |
+| users-hugegraph-capacity | NONE | Indicates the capacity
limit of users in the graph |
+| users-hugegraph-expire | NONE | Indicates the expiration
time of user data |
+| users-hugegraph-hits | NONE | Indicates the number of
hits in the user data cache |
+| users-hugegraph-miss | NONE | Indicates the number of
misses in the user data cache |
+| users-hugegraph-size | NONE | Indicates the number of
users in the current graph |
+| users_pwd-hugegraph-capacity | NONE | Indicates the capacity
limit of user passwords |
+| users_pwd-hugegraph-expire | NONE | Indicates the expiration
time of user password data |
+| users_pwd-hugegraph-hits | NONE | Indicates the number of
hits in the user password data cache|
+| users_pwd-hugegraph-miss | NONE | Indicates the number of
misses in the user password data cache|
+| users_pwd-hugegraph-size | NONE | Indicates the number of
user passwords in the current graph |
+| vertex-hugegraph-capacity | NONE | Indicates the capacity
limit of vertices in the graph |
+| vertex-hugegraph-expire | NONE | Indicates the expiration
time of vertex data |
+| vertex-hugegraph-hits | NONE | Indicates the number of
hits in the vertex data cache |
+| vertex-hugegraph-miss | NONE | Indicates the number of
misses in the vertex data cache |
+| vertex-hugegraph-size | NONE | Indicates the number of
vertices in the current graph |
+| batch-write-threads | NONE | Indicates the number of
threads for batch write operations |
+| max-write-threads | NONE | Indicates the maximum
number of threads for write operations |
+| pending-tasks | NONE | Indicates the number of
pending tasks |
+| workers | NONE | Indicates the current
number of worker threads |
+| average-load-penalty | NONE | Indicates the average
load penalty |
+| estimated-size | NONE | Indicates the estimated
data size |
+| eviction-count | NONE | Indicates the number of
evicted data entries |
+| eviction-weight | NONE | Indicates the weight of
evicted data |
+| hit-count | NONE | Indicates the total
cache hits |
+| hit-rate | NONE | Indicates the cache hit
rate |
+| load-count | NONE | Indicates the number of
data loads |
+| load-failure-count | NONE | Indicates the number of
data load failures |
+| load-failure-rate | NONE | Indicates the data load
failure rate |
+| load-success-count | NONE | Indicates the number of
successful data loads |
+| long-run-compilation-count | NONE | Indicates the number of
long-running compilations |
+| miss-count | NONE | Indicates the total
cache misses |
+| miss-rate | NONE | Indicates the cache miss
rate |
+| request-count | NONE | Indicates the total
request count |
+| total-load-time | NONE | Indicates the total data
load time |
+| sessions | NONE | Indicates the current
number of active sessions |
+
+
+
+
+#### Metric Set: counters
+
+
+
+| Metric Name | Metric Unit | Metric
Description |
+| --------------------------------------------- | -------- |
---------------------------------------- |
+| GET-SUCCESS_COUNTER | NONE | Records the
number of successful GET requests |
+| GET-TOTAL_COUNTER | NONE | Records the
total number of GET requests |
+| favicon-ico-GET-FAILED_COUNTER | NONE | Records the
number of failed GET requests to retrieve favicon.ico |
+| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the
total number of GET requests to retrieve favicon.ico |
+| graphs-HEAD-FAILED_COUNTER | NONE | Records the
number of failed HEAD requests for graphs resources |
+| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the
number of successful HEAD requests for graphs resources |
+| graphs-HEAD-TOTAL_COUNTER | NONE | Records the
total number of HEAD requests for graphs resources |
+| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records
the number of successful GET requests for vertices in HugeGraph graphs |
+| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the
total number of GET requests for vertices in HugeGraph graphs |
+| metrics-GET-FAILED_COUNTER | NONE | Records the
number of failed GET requests to retrieve metrics |
+| metrics-GET-TOTAL_COUNTER | NONE | Records the
total number of GET requests to retrieve metrics |
+| metrics-GET-SUCCESS_COUNTER | NONE | Records the
number of successful GET requests to retrieve metrics |
+| metrics-GET-TOTAL_COUNTER | NONE | Records the
total number of GET requests to retrieve metrics |
+| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the
number of successful GET requests to retrieve metrics gauges |
+| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the
total number of GET requests to retrieve metrics gauges |
+
+
+
+
+#### Metric Set: system
+
+
+
+| Metric Name | Metric Unit | Metric
Description |
+| --------------------------------------------- | -------- |
-------------------------------------------------- |
+| mem | NONE | Indicates the
total memory of the system |
+| mem_total | NONE | Indicates the
total memory of the system (same as mem) |
+| mem_used | NONE | Indicates the
currently used memory of the system |
+| mem_free | NONE | Indicates the
free memory of the system |
+| mem_unit | NONE | Indicates the
unit of memory (such as bytes, kilobytes, megabytes, etc.) |
+| processors | NONE | Indicates the
number of processors in the system |
+| uptime | NONE | Indicates the
system uptime, i.e., the time since booting |
+| systemload_average | NONE | Indicates the
average system load, reflecting the system's busyness |
+| heap_committed | NONE | Indicates the
committed size of JVM heap memory, i.e., the guaranteed heap memory size
available to JVM |
+| heap_init | NONE | Indicates the
initial size of JVM heap memory |
+| heap_used | NONE | Indicates the
currently used JVM heap memory size |
+| heap_max | NONE | Indicates the
maximum available size of JVM heap memory |
+| nonheap_committed | NONE | Indicates the
committed size of JVM non-heap memory |
+| nonheap_init | NONE | Indicates the
initial size of JVM non-heap memory |
+| nonheap_used | NONE | Indicates the
currently used JVM non-heap memory size |
+| nonheap_max | NONE | Indicates the
maximum available size of JVM non-heap memory |
+| thread_peak | NONE | Indicates the
peak number of threads since JVM startup |
+| thread_daemon | NONE | Indicates the
current number of active daemon threads |
+| thread_total_started | NONE | Indicates the
total number of threads started since JVM startup |
+| thread_count | NONE | Indicates the
current number of active threads |
+| garbage_collector_g1_young_generation_count | NONE | Indicates the
number of young generation garbage collections by G1 garbage collector |
+| garbage_collector_g1_young_generation_time | NONE | Indicates the
total time spent in young generation garbage collections by G1 garbage
collector |
+| garbage_collector_g1_old_generation_count | NONE | Indicates the
number of old generation garbage collections by G1 garbage collector |
+| garbage_collector_g1_old_generation_time | NONE | Indicates the
total time spent in old generation garbage collections by G1 garbage collector
|
+| garbage_collector_time_unit | NONE | Indicates the
unit of garbage collection time (such as milliseconds, seconds, etc.) |
\ No newline at end of file
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md
new file mode 100644
index 000000000..8770ababd
--- /dev/null
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md
@@ -0,0 +1,146 @@
+---
+id: hugegraph
+title: 监控：HugeGraph监控
+sidebar_label: Apache HugeGraph
+keywords: [开源监控系统, 开源数据库监控, HugeGraph监控]
+---
+> 对HugeGraph的通用性能指标进行采集监控
+
+**使用协议：HTTP**
+
+## 监控前操作
+
+查看 `rest-server.properties` 文件，获取 `restserver_port` 配置项的值，该值用作监控使用。
+
+## 配置参数
+
+
+| 参数名称 | 参数帮助描述 |
+|-----------|---------------------------------------------------------|
+| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 端口 | HugeGraph restserver的端口号，默认为8080。即:`restserver_port`参数值 |
+| 启动SSL | 使用使用SSL |
+| Base Path | 基础路径，默认为: /metrics ，通常情况下不需要修改 |
+| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
+| 采集间隔 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
+| 是否探测 | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作 |
+| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |
+
+### 采集指标
+
+#### 指标集合：gauges
+
+| 指标名称 | 指标单位 | 指标帮助描述 |
+| ------------------------------------ | -------- |
--------------------------------- |
+| edge-hugegraph-capacity | 无 | 表示当前图中边的容量上限 |
+| edge-hugegraph-expire | 无 | 表示边数据的过期时间 |
+| edge-hugegraph-hits | 无 | 表示边数据缓存的命中次数 |
+| edge-hugegraph-miss | 无 | 表示边数据缓存的未命中次数 |
+| edge-hugegraph-size | 无 | 表示当前图中边的数量 |
+| instances | 无 | 表示当前运行的HugeGraph实例数量|
+| schema-id-hugegraph-capacity | 无 | 表示图中schema ID的容量上限 |
+| schema-id-hugegraph-expire | 无 | 表示schema ID数据的过期时间 |
+| schema-id-hugegraph-hits | 无 | 表示schema ID数据缓存的命中次数|
+| schema-id-hugegraph-miss | 无 | 表示schema ID数据缓存的未命中次数|
+| schema-id-hugegraph-size | 无 | 表示当前图中schema ID的数量 |
+| schema-name-hugegraph-capacity | 无 | 表示图中schema名称的容量上限 |
+| schema-name-hugegraph-expire | 无 | 表示schema名称数据的过期时间 |
+| schema-name-hugegraph-hits | 无 | 表示schema名称数据缓存的命中次数|
+| schema-name-hugegraph-miss | 无 | 表示schema名称数据缓存的未命中次数|
+| schema-name-hugegraph-size | 无 | 表示当前图中schema名称的数量 |
+| token-hugegraph-capacity | 无 | 表示图中token的容量上限 |
+| token-hugegraph-expire | 无 | 表示token数据的过期时间 |
+| token-hugegraph-hits | 无 | 表示token数据缓存的命中次数 |
+| token-hugegraph-miss | 无 | 表示token数据缓存的未命中次数 |
+| token-hugegraph-size | 无 | 表示当前图中token的数量 |
+| users-hugegraph-capacity | 无 | 表示图中用户的容量上限 |
+| users-hugegraph-expire | 无 | 表示用户数据的过期时间 |
+| users-hugegraph-hits | 无 | 表示用户数据缓存的命中次数 |
+| users-hugegraph-miss | 无 | 表示用户数据缓存的未命中次数 |
+| users-hugegraph-size | 无 | 表示当前图中用户的数量 |
+| users_pwd-hugegraph-capacity | 无 | 表示users_pwd的容量上限 |
+| users_pwd-hugegraph-expire | 无 | 表示users_pwd数据的过期时间 |
+| users_pwd-hugegraph-hits | 无 | 表示users_pwd数据缓存的命中次数 |
+| users_pwd-hugegraph-miss | 无 | 表示users_pwd数据缓存的未命中次数|
+| users_pwd-hugegraph-size | 无 | 表示当前图中users_pwd的数量 |
+| vertex-hugegraph-capacity | 无 | 表示图中顶点的容量上限 |
+| vertex-hugegraph-expire | 无 | 表示顶点数据的过期时间 |
+| vertex-hugegraph-hits | 无 | 表示顶点数据缓存的命中次数 |
+| vertex-hugegraph-miss | 无 | 表示顶点数据缓存的未命中次数 |
+| vertex-hugegraph-size | 无 | 表示当前图中顶点的数量 |
+| batch-write-threads | 无 | 表示批量写入操作时的线程数 |
+| max-write-threads | 无 | 表示最大写入操作的线程数 |
+| pending-tasks | 无 | 表示待处理的任务数 |
+| workers | 无 | 表示当前工作线程的数量 |
+| average-load-penalty | 无 | 表示平均加载延迟 |
+| estimated-size | 无 | 表示估计的数据大小 |
+| eviction-count | 无 | 表示被驱逐的数据条数 |
+| eviction-weight | 无 | 表示被驱逐数据的权重 |
+| hit-count | 无 | 表示缓存命中总数 |
+| hit-rate | 无 | 表示缓存命中率 |
+| load-count | 无 | 表示数据加载次数 |
+| load-failure-count | 无 | 表示数据加载失败次数 |
+| load-failure-rate | 无 | 表示数据加载失败率 |
+| load-success-count | 无 | 表示数据加载成功次数 |
+| long-run-compilation-count | 无 | 表示长时间运行的编译次数 |
+| miss-count | 无 | 表示缓存未命中总数 |
+| miss-rate | 无 | 表示缓存未命中率 |
+| request-count | 无 | 表示总的请求次数 |
+| total-load-time | 无 | 表示总的数据加载时间 |
+| sessions | 无 | 表示当前的活动会话数量 |
+
+
+
+#### 指标集合：counters
+
+
+| 指标名称 | 指标单位 | 指标帮助描述
|
+| --------------------------------------------- | -------- |
---------------------------------------- |
+| GET-SUCCESS_COUNTER | 无 | 记录GET请求成功的次数
|
+| GET-TOTAL_COUNTER | 无 | 记录GET请求的总次数
|
+| favicon-ico-GET-FAILED_COUNTER | 无 |
记录获取favicon.ico失败的GET请求次数 |
+| favicon-ico-GET-TOTAL_COUNTER | 无 |
记录获取favicon.ico的GET请求总次数 |
+| graphs-HEAD-FAILED_COUNTER | 无 |
记录graphs资源的HEAD请求失败的次数 |
+| graphs-HEAD-SUCCESS_COUNTER | 无 |
记录graphs资源的HEAD请求成功的次数 |
+| graphs-HEAD-TOTAL_COUNTER | 无 |
记录graphs资源的HEAD请求的总次数 |
+| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | 无 |
记录获取HugeGraph图中顶点的GET请求成功的次数 |
+| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | 无 |
记录获取HugeGraph图中顶点的GET请求的总次数 |
+| metircs-GET-FAILED_COUNTER | 无 |
记录获取metrics失败的GET请求次数 |
+| metircs-GET-TOTAL_COUNTER | 无 |
记录获取metrics的GET请求总次数 |
+| metrics-GET-SUCCESS_COUNTER | 无 |
记录获取metrics成功的GET请求次数 |
+| metrics-GET-TOTAL_COUNTER | 无 |
记录获取metrics的GET请求总次数 |
+| metrics-gauges-GET-SUCCESS_COUNTER | 无 | 记录获取metrics
gauges成功的GET请求次数 |
+| metrics-gauges-GET-TOTAL_COUNTER | 无 | 记录获取metrics
gauges的GET请求总次数 |
+
+
+
+#### 指标集合：system
+
+
+| 指标名称 | 指标单位 | 指标帮助描述
|
+| --------------------------------------------- | -------- |
-------------------------------------------------- |
+| mem | 无 | 表示系统的总内存量
|
+| mem_total | 无 | 表示系统的总内存量（与mem相同）
|
+| mem_used | 无 | 表示系统当前使用的内存量
|
+| mem_free | 无 | 表示系统空闲的内存量
|
+| mem_unit | 无 |
表示内存量的单位（如字节、千字节、兆字节等） |
+| processors | 无 | 表示系统的处理器数量
|
+| uptime | 无 |
表示系统运行时间，即从启动到现在的时间 |
+| systemload_average | 无 |
表示系统的平均负载，反映了系统的繁忙程度 |
+| heap_committed | 无 |
表示JVM堆内存的承诺大小，即保证可供JVM使用的堆内存大小 |
+| heap_init | 无 | 表示JVM堆内存的初始大小
|
+| heap_used | 无 | 表示JVM当前使用的堆内存大小
|
+| heap_max | 无 | 表示JVM堆内存的最大可使用大小
|
+| nonheap_committed | 无 | 表示JVM非堆内存的承诺大小
|
+| nonheap_init | 无 | 表示JVM非堆内存的初始大小
|
+| nonheap_used | 无 | 表示JVM当前使用的非堆内存大小
|
+| nonheap_max | 无 | 表示JVM非堆内存的最大可使用大小
|
+| thread_peak | 无 | 表示自JVM启动以来峰值线程数
|
+| thread_daemon | 无 | 表示当前活跃的守护线程数
|
+| thread_total_started | 无 |
表示自JVM启动以来总共启动过的线程数 |
+| thread_count | 无 | 表示当前活跃的线程数
|
+| garbage_collector_g1_young_generation_count | 无 |
表示G1垃圾收集器年轻代垃圾收集的次数 |
+| garbage_collector_g1_young_generation_time | 无 |
表示G1垃圾收集器年轻代垃圾收集的总时间 |
+| garbage_collector_g1_old_generation_count | 无 |
表示G1垃圾收集器老年代垃圾收集的次数 |
+| garbage_collector_g1_old_generation_time | 无 |
表示G1垃圾收集器老年代垃圾收集的总时间 |
+| garbage_collector_time_unit | 无 |
表示垃圾收集时间的单位（如毫秒、秒等） |
diff --git a/home/sidebars.json b/home/sidebars.json
index 41835c432..c80dc3bfa 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -242,7 +242,8 @@
"help/airflow",
"help/clickhouse",
"help/elasticsearch",
- "help/influxdb"
+ "help/influxdb",
+ "help/hugegraph"
]
},
{
diff --git a/manager/src/main/resources/define/hugegraph.yml
b/manager/src/main/resources/define/hugegraph.yml
new file mode 100644
index 000000000..d5ee386e5
--- /dev/null
+++ b/manager/src/main/resources/define/hugegraph.yml
@@ -0,0 +1,889 @@
+# 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: hugegraph linux windows tomcat mysql aws...
+app: hugegraph
+# The monitoring i18n name
+name:
+ zh-CN: HugeGraph
+ en-US: HugeGraph
+# The description and help of this monitoring type
+help:
+ zh-CN: Hertzbeat 对 HugeGraph 节点监控指标进行监控。<br>您可以点击 “<i>新建 Apache
HugeGraph</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
+ en-US: Hertzbeat monitors the HugeGraph metrics. <br>You can click "<i>New
Apache HugeGraph</i>" to configure, or select "<i>More Actions</i>" to import
an existing configuration.
+ zh-TW: Hertzbeat 對 HugeGraph 節點監控指標進行監控。<br>您可以點擊 “<i>新建 Apache
HugeGraph</i>” 並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
+
+helpLink:
+ zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/hugegraph
+ en-US: https://hertzbeat.apache.org/docs/help/hugegraph
+# 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: 8080
+ # field-param field key
+ - field: ssl
+ # name-param field display i18n name
+ name:
+ zh-CN: 启动SSL
+ en-US: SSL
+ # When the type is boolean, the frontend will display a switch for it.
+ type: boolean
+ # required-true or false
+ required: false
+ # field-param field key
+ - field: base_path
+ # name-param field display i18n name
+ name:
+ zh-CN: Base Path
+ en-US: Base Path
+ # type-param field type(most mapping the html input type) The type "text"
belongs to a text input field.
+ type: text
+ # default value
+ defaultValue: /metrics
+ # required-true or false
+ required: true
+ # hide-true or false
+ hide: true
+# collect metrics config list
+metrics:
+ # metrics - environment
+ - name: gauges
+ priority: 1
+ # The specific monitoring metrics in the metric group.
+ # 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: edge-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: edge-hugegraph-capacity
+ en-US: edge-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: edge-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: edge-hugegraph-expire
+ en-US: edge-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: edge-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: edge-hugegraph-hits
+ en-US: edge-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: edge-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: edge-hugegraph-miss
+ en-US: edge-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: edge-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: edge-hugegraph-size
+ en-US: edge-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: instances
+ type: 0
+ i18n:
+ zh-CN: instances
+ en-US: instances
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-id-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: schema-id-hugegraph-capacity
+ en-US: schema-id-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-id-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: schema-id-hugegraph-expire
+ en-US: schema-id-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-id-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: schema-id-hugegraph-hits
+ en-US: schema-id-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-id-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: schema-id-hugegraph-miss
+ en-US: schema-id-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-id-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: schema-id-hugegraph-size
+ en-US: schema-id-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-name-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: schema-name-hugegraph-capacity
+ en-US: schema-name-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-name-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: schema-name-hugegraph-expire
+ en-US: schema-name-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-name-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: schema-name-hugegraph-hits
+ en-US: schema-name-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-name-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: schema-name-hugegraph-miss
+ en-US: schema-name-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: schema-name-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: schema-name-hugegraph-size
+ en-US: schema-name-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: token-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: token-hugegraph-capacity
+ en-US: token-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: token-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: token-hugegraph-expire
+ en-US: token-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: token-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: token-hugegraph-hits
+ en-US: token-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: token-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: token-hugegraph-miss
+ en-US: token-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: token-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: token-hugegraph-size
+ en-US: token-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: users-hugegraph-capacity
+ en-US: users-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: users-hugegraph-expire
+ en-US: users-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: users-hugegraph-hits
+ en-US: users-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: users-hugegraph-miss
+ en-US: users-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: users-hugegraph-size
+ en-US: users-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users_pwd-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: users_pwd-hugegraph-capacity
+ en-US: users_pwd-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users_pwd-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: users_pwd-hugegraph-expire
+ en-US: users_pwd-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users_pwd-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: users_pwd-hugegraph-hits
+ en-US: users_pwd-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users_pwd-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: users_pwd-hugegraph-miss
+ en-US: users_pwd-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: users_pwd-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: users_pwd-hugegraph-size
+ en-US: users_pwd-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: vertex-hugegraph-capacity
+ type: 0
+ i18n:
+ zh-CN: vertex-hugegraph-capacity
+ en-US: vertex-hugegraph-capacity
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: vertex-hugegraph-expire
+ type: 0
+ i18n:
+ zh-CN: vertex-hugegraph-expire
+ en-US: vertex-hugegraph-expire
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: vertex-hugegraph-hits
+ type: 0
+ i18n:
+ zh-CN: vertex-hugegraph-hits
+ en-US: vertex-hugegraph-hits
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: vertex-hugegraph-miss
+ type: 0
+ i18n:
+ zh-CN: vertex-hugegraph-miss
+ en-US: vertex-hugegraph-miss
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: vertex-hugegraph-size
+ type: 0
+ i18n:
+ zh-CN: vertex-hugegraph-size
+ en-US: vertex-hugegraph-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: batch-write-threads
+ type: 0
+ i18n:
+ zh-CN: batch-write-threads
+ en-US: batch-write-threads
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: max-write-threads
+ type: 0
+ i18n:
+ zh-CN: max-write-threads
+ en-US: max-write-threads
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: pending-tasks
+ type: 0
+ i18n:
+ zh-CN: pending-tasks
+ en-US: pending-tasks
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: workers
+ type: 0
+ i18n:
+ zh-CN: workers
+ en-US: workers
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: average-load-penalty
+ type: 0
+ i18n:
+ zh-CN: average-load-penalty
+ en-US: average-load-penalty
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: estimated-size
+ type: 0
+ i18n:
+ zh-CN: estimated-size
+ en-US: estimated-size
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: eviction-count
+ type: 0
+ i18n:
+ zh-CN: eviction-count
+ en-US: eviction-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: eviction-weight
+ type: 0
+ i18n:
+ zh-CN: eviction-weight
+ en-US: eviction-weight
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: hit-count
+ type: 0
+ i18n:
+ zh-CN: hit-count
+ en-US: hit-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: hit-rate
+ type: 0
+ i18n:
+ zh-CN: hit-rate
+ en-US: hit-rate
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: load-count
+ type: 0
+ i18n:
+ zh-CN: load-count
+ en-US: load-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: load-failure-count
+ type: 0
+ i18n:
+ zh-CN: load-failure-count
+ en-US: load-failure-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: load-failure-rate
+ type: 0
+ i18n:
+ zh-CN: load-failure-rate
+ en-US: load-failure-rate
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: load-success-count
+ type: 0
+ i18n:
+ zh-CN: load-success-count
+ en-US: load-success-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: long-run-compilation-count
+ type: 0
+ i18n:
+ zh-CN: long-run-compilation-count
+ en-US: long-run-compilation-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: miss-count
+ type: 0
+ i18n:
+ zh-CN: miss-count
+ en-US: miss-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: miss-rate
+ type: 0
+ i18n:
+ zh-CN: miss-rate
+ en-US: miss-rate
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: request-count
+ type: 0
+ i18n:
+ zh-CN: request-count
+ en-US: request-count
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: total-load-time
+ type: 0
+ i18n:
+ zh-CN: total-load-time
+ en-US: total-load-time
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: sessions
+ type: 0
+ i18n:
+ zh-CN: sessions
+ en-US: sessions
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ aliasFields:
+ -
$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size'].['value']
+ - $.['org.apache.hugegraph.backend.cache.Cache.instances'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss'].['value']
+ -
$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size'].['value']
+ -
$.['org.apache.hugegraph.server.RestServer.batch-write-threads'].['value']
+ -
$.['org.apache.hugegraph.server.RestServer.max-write-threads'].['value']
+ - $.['org.apache.hugegraph.task.TaskManager.pending-tasks'].['value']
+ - $.['org.apache.hugegraph.task.TaskManager.workers'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time'].['value']
+ -
$.['org.apache.tinkerpop.gremlin.server.GremlinServer.sessions'].['value']
+ calculates:
+ -
edge-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity'].['value']
+ -
edge-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire'].['value']
+ -
edge-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits'].['value']
+ -
edge-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss'].['value']
+ -
edge-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size'].['value']
+ -
instances=$.['org.apache.hugegraph.backend.cache.Cache.instances'].['value']
+ -
schema-id-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity'].['value']
+ -
schema-id-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire'].['value']
+ -
schema-id-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits'].['value']
+ -
schema-id-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss'].['value']
+ -
schema-id-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size'].['value']
+ -
schema-name-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity'].['value']
+ -
schema-name-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire'].['value']
+ -
schema-name-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits'].['value']
+ -
schema-name-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss'].['value']
+ -
schema-name-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size'].['value']
+ -
token-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity'].['value']
+ -
token-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire'].['value']
+ -
token-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits'].['value']
+ -
token-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss'].['value']
+ -
token-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size'].['value']
+ -
users-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity'].['value']
+ -
users-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire'].['value']
+ -
users-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits'].['value']
+ -
users-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss'].['value']
+ -
users-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size'].['value']
+ -
users_pwd-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity'].['value']
+ -
users_pwd-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire'].['value']
+ -
users_pwd-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits'].['value']
+ -
users_pwd-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss'].['value']
+ -
users_pwd-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size'].['value']
+ -
vertex-hugegraph-capacity=$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity'].['value']
+ -
vertex-hugegraph-expire=$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire'].['value']
+ -
vertex-hugegraph-hits=$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits'].['value']
+ -
vertex-hugegraph-miss=$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss'].['value']
+ -
vertex-hugegraph-size=$.['org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size'].['value']
+ -
batch-write-threads=$.['org.apache.hugegraph.server.RestServer.batch-write-threads'].['value']
+ -
max-write-threads=$.['org.apache.hugegraph.server.RestServer.max-write-threads'].['value']
+ -
pending-tasks=$.['org.apache.hugegraph.task.TaskManager.pending-tasks'].['value']
+ - workers=$.['org.apache.hugegraph.task.TaskManager.workers'].['value']
+ -
average-load-penalty=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty'].['value']
+ -
estimated-size=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size'].['value']
+ -
eviction-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count'].['value']
+ -
eviction-weight=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight'].['value']
+ -
hit-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count'].['value']
+ -
hit-rate=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate'].['value']
+ -
load-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count'].['value']
+ -
load-failure-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count'].['value']
+ -
load-failure-rate=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate'].['value']
+ -
load-success-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count'].['value']
+ -
long-run-compilation-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count'].['value']
+ -
miss-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count'].['value']
+ -
miss-rate=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate'].['value']
+ -
request-count=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count'].['value']
+ -
total-load-time=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time'].['value']
+ -
sessions=$.['org.apache.tinkerpop.gremlin.server.GremlinServer.sessions'].['value']
+ # The protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp,
sdk
+ protocol: http
+ # Specific collection configuration when protocol is http protocol
+ http:
+ # http host: ipv4 ipv6 domain
+ host: ^_^host^_^
+ # http port
+ port: ^_^port^_^
+ # http url
+ url: ^_^base_path^_^/gauges?type=json
+ # http request method GET POST PUT DELETE PATCH
+ method: GET
+ # enable SSL/TLS, that is, whether it is http or https, the default is
false
+ ssl: ^_^ssl^_^
+ # http response data parse type: default-hertzbeat rule,
jsonpath-jsonpath script, website-api availability monitoring
+ parseType: jsonPath
+ # http response data parse script
+ parseScript: '$'
+
+ - name: counters
+ 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: GET-SUCCESS_COUNTER
+ type: 0
+ i18n:
+ zh-CN: GET-SUCCESS_COUNTER
+ en-US: GET-SUCCESS_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: GET-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: GET-TOTAL_COUNTER
+ en-US: GET-TOTAL_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: favicon-ico-GET-FAILED_COUNTER
+ type: 0
+ i18n:
+ zh-CN: favicon-ico-GET-FAILED_COUNTER
+ en-US: favicon-ico-GET-FAILED_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: favicon-ico-GET-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: favicon-ico-GET-TOTAL_COUNTER
+ en-US: favicon-ico-GET-TOTAL_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: graphs-HEAD-FAILED_COUNTER
+ type: 0
+ i18n:
+ zh-CN: graphs-HEAD-FAILED_COUNTER
+ en-US: graphs-HEAD-FAILED_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: graphs-HEAD-SUCCESS_COUNTER
+ type: 0
+ i18n:
+ zh-CN: graphs-HEAD-SUCCESS_COUNTER
+ en-US: graphs-HEAD-SUCCESS_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: graphs-HEAD-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: graphs-HEAD-TOTAL_COUNTER
+ en-US: graphs-HEAD-TOTAL_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER
+ type: 0
+ i18n:
+ zh-CN: graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER
+ en-US: graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER
+ en-US: graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: metircs-GET-FAILED_COUNTER
+ type: 0
+ i18n:
+ zh-CN: metircs-GET-FAILED_COUNTER
+ en-US: metircs-GET-FAILED_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: metircs-GET-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: metircs-GET-TOTAL_COUNTER
+ en-US: metircs-GET-TOTAL_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: metrics-GET-SUCCESS_COUNTER
+ type: 0
+ i18n:
+ zh-CN: metrics-GET-SUCCESS_COUNTER
+ en-US: metrics-GET-SUCCESS_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: metrics-GET-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: metrics-GET-TOTAL_COUNTER
+ en-US: metrics-GET-TOTAL_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: metrics-gauges-GET-SUCCESS_COUNTER
+ type: 0
+ i18n:
+ zh-CN: metrics-gauges-GET-SUCCESS_COUNTER
+ en-US: metrics-gauges-GET-SUCCESS_COUNTER
+ # field-metric name, type-metric type(0-number,1-string), unit-metric
unit('%','ms','MB'), label-whether it is a metrics label field
+ - field: metrics-gauges-GET-TOTAL_COUNTER
+ type: 0
+ i18n:
+ zh-CN: metrics-gauges-GET-TOTAL_COUNTER
+ en-US: metrics-gauges-GET-TOTAL_COUNTER
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ aliasFields:
+ - $.['//GET/SUCCESS_COUNTER'].['count']
+ - $.['//GET/TOTAL_COUNTER'].['count']
+ - $.['/favicon.ico/GET/FAILED_COUNTER'].['count']
+ - $.['/favicon.ico/GET/TOTAL_COUNTER'].['count']
+ - $.['/graphs/HEAD/FAILED_COUNTER'].['count']
+ - $.['/graphs/HEAD/SUCCESS_COUNTER'].['count']
+ - $.['/graphs/HEAD/TOTAL_COUNTER'].['count']
+ - $.['/graphs/hugegraph/graph/vertices/GET/SUCCESS_COUNTER'].['count']
+ - $.['/graphs/hugegraph/graph/vertices/GET/TOTAL_COUNTER'].['count']
+ - $.['/metircs/GET/FAILED_COUNTER'].['count']
+ - $.['/metircs/GET/TOTAL_COUNTER'].['count']
+ - $.['/metrics/GET/SUCCESS_COUNTER'].['count']
+ - $.['/metrics/GET/TOTAL_COUNTER'].['count']
+ - $.['/metrics/gauges/GET/SUCCESS_COUNTER'].['count']
+ - $.['/metrics/gauges/GET/TOTAL_COUNTER'].['count']
+ calculates:
+ - GET-SUCCESS_COUNTER=$.['//GET/SUCCESS_COUNTER'].['count']
+ - GET-TOTAL_COUNTER=$.['//GET/TOTAL_COUNTER'].['count']
+ -
favicon-ico-GET-FAILED_COUNTER=$.['/favicon.ico/GET/FAILED_COUNTER'].['count']
+ -
favicon-ico-GET-TOTAL_COUNTER=$.['/favicon.ico/GET/TOTAL_COUNTER'].['count']
+ - graphs-HEAD-FAILED_COUNTER=$.['/graphs/HEAD/FAILED_COUNTER'].['count']
+ -
graphs-HEAD-SUCCESS_COUNTER=$.['/graphs/HEAD/SUCCESS_COUNTER'].['count']
+ - graphs-HEAD-TOTAL_COUNTER=$.['/graphs/HEAD/TOTAL_COUNTER'].['count']
+ -
graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER=$.['/graphs/hugegraph/graph/vertices/GET/SUCCESS_COUNTER'].['count']
+ -
graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER=$.['/graphs/hugegraph/graph/vertices/GET/TOTAL_COUNTER'].['count']
+ - metircs-GET-FAILED_COUNTER=$.['/metircs/GET/FAILED_COUNTER'].['count']
+ - metircs-GET-TOTAL_COUNTER=$.['/metircs/GET/TOTAL_COUNTER'].['count']
+ -
metrics-GET-SUCCESS_COUNTER=$.['/metrics/GET/SUCCESS_COUNTER'].['count']
+ - metrics-GET-TOTAL_COUNTER=$.['/metrics/GET/TOTAL_COUNTER'].['count']
+ -
metrics-gauges-GET-SUCCESS_COUNTER=$.['/metrics/gauges/GET/SUCCESS_COUNTER'].['count']
+ -
metrics-gauges-GET-TOTAL_COUNTER=$.['/metrics/gauges/GET/TOTAL_COUNTER'].['count']
+ protocol: http
+ http:
+ host: ^_^host^_^
+ port: ^_^port^_^
+ url: ^_^base_path^_^/counters?type=json
+ method: GET
+ ssl: ^_^ssl^_^
+ parseType: jsonPath
+ parseScript: '$'
+
+ - name: system
+ 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: mem
+ type: 0
+ i18n:
+ zh-CN: mem
+ en-US: mem
+ - field: mem_total
+ type: 0
+ i18n:
+ zh-CN: mem_total
+ en-US: mem_total
+ - field: mem_used
+ type: 0
+ i18n:
+ zh-CN: mem_used
+ en-US: mem_used
+ - field: mem_free
+ type: 0
+ i18n:
+ zh-CN: mem_free
+ en-US: mem_free
+ - field: mem_unit
+ type: 1
+ i18n:
+ zh-CN: mem_unit
+ en-US: mem_unit
+ - field: processors
+ type: 0
+ i18n:
+ zh-CN: processors
+ en-US: processors
+ - field: uptime
+ type: 0
+ i18n:
+ zh-CN: uptime
+ en-US: uptime
+ - field: systemload_average
+ type: 0
+ i18n:
+ zh-CN: systemload_average
+ en-US: systemload_average
+ - field: heap_committed
+ type: 0
+ i18n:
+ zh-CN: heap_committed
+ en-US: heap_committed
+ - field: heap_init
+ type: 0
+ i18n:
+ zh-CN: heap_init
+ en-US: heap_init
+ - field: heap_used
+ type: 0
+ i18n:
+ zh-CN: heap_used
+ en-US: heap_used
+ - field: heap_max
+ type: 0
+ i18n:
+ zh-CN: heap_max
+ en-US: heap_max
+ - field: nonheap_committed
+ type: 0
+ i18n:
+ zh-CN: nonheap_committed
+ en-US: nonheap_committed
+ - field: nonheap_init
+ type: 0
+ i18n:
+ zh-CN: nonheap_init
+ en-US: nonheap_init
+ - field: nonheap_used
+ type: 0
+ i18n:
+ zh-CN: nonheap_used
+ en-US: nonheap_used
+ - field: nonheap_max
+ type: 0
+ i18n:
+ zh-CN: nonheap_max
+ en-US: nonheap_max
+ - field: thread_peak
+ type: 0
+ i18n:
+ zh-CN: thread_peak
+ en-US: thread_peak
+ - field: thread_daemon
+ type: 0
+ i18n:
+ zh-CN: thread_daemon
+ en-US: thread_daemon
+ - field: thread_total_started
+ type: 0
+ i18n:
+ zh-CN: thread_total_started
+ en-US: thread_total_started
+ - field: thread_count
+ type: 0
+ i18n:
+ zh-CN: thread_count
+ en-US: thread_count
+ - field: garbage_collector_g1_young_generation_count
+ type: 0
+ i18n:
+ zh-CN: garbage_collector_g1_young_generation_count
+ en-US: garbage_collector_g1_young_generation_count
+ - field: garbage_collector_g1_young_generation_time
+ type: 0
+ i18n:
+ zh-CN: garbage_collector_g1_young_generation_time
+ en-US: garbage_collector_g1_young_generation_time
+ - field: garbage_collector_g1_old_generation_count
+ type: 0
+ i18n:
+ zh-CN: garbage_collector_g1_old_generation_count
+ en-US: garbage_collector_g1_old_generation_count
+ - field: garbage_collector_g1_old_generation_time
+ type: 0
+ i18n:
+ zh-CN: garbage_collector_g1_old_generation_time
+ en-US: garbage_collector_g1_old_generation_time
+ - field: garbage_collector_time_unit
+ type: 1
+ i18n:
+ zh-CN: garbage_collector_time_unit
+ en-US: garbage_collector_time_unit
+ # (optional)metrics field alias name, it is used as an alias field to map
and convert the collected data and metrics field
+ aliasFields:
+ - $.basic.mem
+ - $.basic.mem_total
+ - $.basic.mem_used
+ - $.basic.mem_free
+ - $.basic.mem_unit
+ - $.basic.processors
+ - $.basic.uptime
+ - $.basic.systemload_average
+ - $.heap.committed
+ - $.heap.init
+ - $.heap.used
+ - $.heap.max
+ - $.nonheap.committed
+ - $.nonheap.init
+ - $.nonheap.used
+ - $.nonheap.max
+ - $.thread.peak
+ - $.thread.daemon
+ - $.thread.total_started
+ - $.thread.count
+ - $.garbage_collector.g1_young_generation_count
+ - $.garbage_collector.g1_young_generation_time
+ - $.garbage_collector.g1_old_generation_count
+ - $.garbage_collector.g1_old_generation_time
+ - $.garbage_collector.time_unit
+ calculates:
+ - mem=$.basic.mem
+ - mem_total=$.basic.mem_total
+ - mem_used=$.basic.mem_used
+ - mem_free=$.basic.mem_free
+ - mem_unit=$.basic.mem_unit
+ - processors=$.basic.processors
+ - uptime=$.basic.uptime
+ - systemload_average=$.basic.systemload_average
+ - heap_committed=$.heap.committed
+ - heap_init=$.heap.init
+ - heap_used=$.heap.used
+ - heap_max=$.heap.max
+ - nonheap_committed=$.nonheap.committed
+ - nonheap_init=$.nonheap.init
+ - nonheap_used=$.nonheap.used
+ - nonheap_max=$.nonheap.max
+ - thread_peak=$.thread.peak
+ - thread_daemon=$.thread.daemon
+ - thread_total_started=$.thread.total_started
+ - thread_count=$.thread.count
+ -
garbage_collector_g1_young_generation_count=$.garbage_collector.g1_young_generation_count
+ -
garbage_collector_g1_young_generation_time=$.garbage_collector.g1_young_generation_time
+ -
garbage_collector_g1_old_generation_count=$.garbage_collector.g1_old_generation_count
+ -
garbage_collector_g1_old_generation_time=$.garbage_collector.g1_old_generation_time
+ - garbage_collector_time_unit=$.garbage_collector.time_unit
+ protocol: http
+ http:
+ host: ^_^host^_^
+ port: ^_^port^_^
+ url: ^_^base_path^_^/system?type=json
+ method: GET
+ ssl: ^_^ssl^_^
+ parseType: jsonPath
+ parseScript: '$'
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
