Skip to content

Commit 9263727

Browse files
zhangshenghangtomsun28
zhangshenghang
and
tomsun28
authored
[feature] add apache hugegraph monitor (apache#1972)
Co-authored-by: zhangshenghang <[email protected]> Co-authored-by: tomsun28 <[email protected]>
1 parent 39a587f commit 9263727

File tree

4 files changed

+1187
-1
lines changed

4 files changed

+1187
-1
lines changed

‎home/docs/help/hugegraph.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
id: hugegraph
3+
title: Monitoring HugeGraph Monitoring
4+
sidebar_label: Apache HugeGraph
5+
keywords: [Open Source Monitoring System, Open Source Database Monitoring, HugeGraph Monitoring]
6+
---
7+
> Collect and monitor the general performance metrics of HugeGraph
8+
9+
**Protocol used: HTTP**
10+
11+
## Pre-monitoring Operations
12+
13+
Check the `rest-server.properties` file to obtain the value of the `restserver_port` configuration item, which is used for monitoring.
14+
15+
## Configuration Parameters
16+
17+
18+
| Parameter Name | Parameter Description |
19+
|------------------|--------------------------------------------------------|
20+
| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). |
21+
| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter |
22+
| Enable SSL | Enable SSL usage |
23+
| Base Path | Base path, default is: /metrics, usually does not need to be modified |
24+
| Task Name | Identifies the name of this monitoring, ensuring uniqueness. |
25+
| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds |
26+
| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful |
27+
| Description | Additional identification and description of this monitoring, users can add information here |
28+
29+
### Metrics Collection
30+
31+
#### Metric Set: gauges
32+
33+
| Metric Name | Metric Unit | Metric Description |
34+
| ------------------------------------ | -------- | --------------------------------- |
35+
| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph |
36+
| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data |
37+
| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache |
38+
| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache |
39+
| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph |
40+
| instances | NONE | Indicates the number of currently running HugeGraph instances|
41+
| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph |
42+
| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data |
43+
| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache|
44+
| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache|
45+
| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph |
46+
| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph |
47+
| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data |
48+
| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache|
49+
| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache|
50+
| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph |
51+
| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph |
52+
| token-hugegraph-expire | NONE | Indicates the expiration time of token data |
53+
| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache |
54+
| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache |
55+
| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph |
56+
| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph |
57+
| users-hugegraph-expire | NONE | Indicates the expiration time of user data |
58+
| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache |
59+
| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache |
60+
| users-hugegraph-size | NONE | Indicates the number of users in the current graph |
61+
| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords |
62+
| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data |
63+
| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache|
64+
| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache|
65+
| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph |
66+
| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph |
67+
| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data |
68+
| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache |
69+
| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache |
70+
| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph |
71+
| batch-write-threads | NONE | Indicates the number of threads for batch write operations |
72+
| max-write-threads | NONE | Indicates the maximum number of threads for write operations |
73+
| pending-tasks | NONE | Indicates the number of pending tasks |
74+
| workers | NONE | Indicates the current number of worker threads |
75+
| average-load-penalty | NONE | Indicates the average load penalty |
76+
| estimated-size | NONE | Indicates the estimated data size |
77+
| eviction-count | NONE | Indicates the number of evicted data entries |
78+
| eviction-weight | NONE | Indicates the weight of evicted data |
79+
| hit-count | NONE | Indicates the total cache hits |
80+
| hit-rate | NONE | Indicates the cache hit rate |
81+
| load-count | NONE | Indicates the number of data loads |
82+
| load-failure-count | NONE | Indicates the number of data load failures |
83+
| load-failure-rate | NONE | Indicates the data load failure rate |
84+
| load-success-count | NONE | Indicates the number of successful data loads |
85+
| long-run-compilation-count | NONE | Indicates the number of long-running compilations |
86+
| miss-count | NONE | Indicates the total cache misses |
87+
| miss-rate | NONE | Indicates the cache miss rate |
88+
| request-count | NONE | Indicates the total request count |
89+
| total-load-time | NONE | Indicates the total data load time |
90+
| sessions | NONE | Indicates the current number of active sessions |
91+
92+
93+
94+
95+
#### Metric Set: counters
96+
97+
98+
99+
| Metric Name | Metric Unit | Metric Description |
100+
| --------------------------------------------- | -------- | ---------------------------------------- |
101+
| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests |
102+
| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests |
103+
| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico |
104+
| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico |
105+
| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources |
106+
| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources |
107+
| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources |
108+
| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs |
109+
| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs |
110+
| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics |
111+
| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics |
112+
| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics |
113+
| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics |
114+
| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges |
115+
| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges |
116+
117+
118+
119+
120+
#### Metric Set: system
121+
122+
123+
124+
| Metric Name | Metric Unit | Metric Description |
125+
| --------------------------------------------- | -------- | -------------------------------------------------- |
126+
| mem | NONE | Indicates the total memory of the system |
127+
| mem_total | NONE | Indicates the total memory of the system (same as mem) |
128+
| mem_used | NONE | Indicates the currently used memory of the system |
129+
| mem_free | NONE | Indicates the free memory of the system |
130+
| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) |
131+
| processors | NONE | Indicates the number of processors in the system |
132+
| uptime | NONE | Indicates the system uptime, i.e., the time since booting |
133+
| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness |
134+
| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM |
135+
| heap_init | NONE | Indicates the initial size of JVM heap memory |
136+
| heap_used | NONE | Indicates the currently used JVM heap memory size |
137+
| heap_max | NONE | Indicates the maximum available size of JVM heap memory |
138+
| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory |
139+
| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory |
140+
| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size |
141+
| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory |
142+
| thread_peak | NONE | Indicates the peak number of threads since JVM startup |
143+
| thread_daemon | NONE | Indicates the current number of active daemon threads |
144+
| thread_total_started | NONE | Indicates the total number of threads started since JVM startup |
145+
| thread_count | NONE | Indicates the current number of active threads |
146+
| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector |
147+
| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector |
148+
| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector |
149+
| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector |
150+
| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) |

0 commit comments

Comments
 (0)