From a35bbebd6ce8157b64e1d9e4834033735eaa2944 Mon Sep 17 00:00:00 2001 From: 1289220708 <1289220708@qq.com> Date: Sat, 28 Oct 2023 20:51:31 +0800 Subject: [PATCH 1/5] feat(website): add metric api doc --- content/cn/docs/clients/restful-api/_index.md | 2 + .../cn/docs/clients/restful-api/metrics.md | 1314 ++++++++++++++++ content/en/docs/clients/restful-api/_index.md | 2 + .../en/docs/clients/restful-api/metrics.md | 1315 +++++++++++++++++ 4 files changed, 2633 insertions(+) create mode 100644 content/cn/docs/clients/restful-api/metrics.md create mode 100644 content/en/docs/clients/restful-api/metrics.md diff --git a/content/cn/docs/clients/restful-api/_index.md b/content/cn/docs/clients/restful-api/_index.md index 85788b666..08d554395 100644 --- a/content/cn/docs/clients/restful-api/_index.md +++ b/content/cn/docs/clients/restful-api/_index.md @@ -43,4 +43,6 @@ HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的 [comment]: <> (- [Authentication](restful-api/auth.md)) +[comment]: <> (- [Metrics](restful-api/metrics.md)) + [comment]: <> (- [Other](restful-api/other.md)) diff --git a/content/cn/docs/clients/restful-api/metrics.md b/content/cn/docs/clients/restful-api/metrics.md new file mode 100644 index 000000000..9a4e8e0b4 --- /dev/null +++ b/content/cn/docs/clients/restful-api/metrics.md @@ -0,0 +1,1314 @@ +--- +title: "Metrics API" +linkTitle: "Metrics" +weight: 1 + +--- + +HugeGraph 提供Metrics 信息披露，包括：基础指标、统计指标、系统指标、后端指标。 + + +## 1. 基础指标 + +### 1.1 获取所有基础指标 + + +##### Params + +- type：如果传值为json，则以json格式返回，否则以Promethaus格式返回。 + +##### 1.1.1 Method & Url + +``` +http://localhost:8080/metrics/?type=json +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "gauges":{ + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity":{ + "value":1000000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.instances":{ + "value":7 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity":{ + "value":10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size":{ + "value":17 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity":{ + "value":10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size":{ + "value":17 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity":{ + "value":10240 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity":{ + "value":10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity":{ + "value":10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity":{ + "value":10000000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.server.RestServer.max-write-threads":{ + "value":0 + }, + "org.apache.hugegraph.task.TaskManager.pending-tasks":{ + "value":0 + }, + "org.apache.hugegraph.task.TaskManager.workers":{ + "value":4 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty":{ + "value":922769200 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate":{ + "value":1 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time":{ + "value":1845538400 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions":{ + "value":0 + } + }, + "counters":{ + "favicon.ico/GET/FAILED_COUNTER":{ + "count":1 + }, + "favicon.ico/GET/TOTAL_COUNTER":{ + "count":1 + }, + "metrics/POST/FAILED_COUNTER":{ + "count":1 + }, + "metrics/POST/TOTAL_COUNTER":{ + "count":1 + }, + "metrics/backend/GET/SUCCESS_COUNTER":{ + "count":2 + }, + "metrics/backend/GET/TOTAL_COUNTER":{ + "count":2 + }, + "metrics/gauges/GET/SUCCESS_COUNTER":{ + "count":1 + }, + "metrics/gauges/GET/TOTAL_COUNTER":{ + "count":1 + }, + "metrics/system/GET/SUCCESS_COUNTER":{ + "count":2 + }, + "metrics/system/GET/TOTAL_COUNTER":{ + "count":2 + }, + "system/GET/FAILED_COUNTER":{ + "count":1 + }, + "system/GET/TOTAL_COUNTER":{ + "count":1 + } + }, + "histograms":{ + "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":1, + "mean":1, + "max":1, + "stddev":0, + "p50":1, + "p75":1, + "p95":1, + "p98":1, + "p99":1, + "p999":1 + }, + "metrics/POST/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":21, + "mean":21, + "max":21, + "stddev":0, + "p50":21, + "p75":21, + "p95":21, + "p98":21, + "p99":21, + "p999":21 + }, + "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":2, + "min":6, + "mean":12.6852124529148, + "max":20, + "stddev":6.992918475157571, + "p50":6, + "p75":20, + "p95":20, + "p98":20, + "p99":20, + "p999":20 + }, + "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":7, + "mean":7, + "max":7, + "stddev":0, + "p50":7, + "p75":7, + "p95":7, + "p98":7, + "p99":7, + "p999":7 + }, + "metrics/system/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":2, + "min":0, + "mean":8.942674506664073, + "max":40, + "stddev":16.665399873223066, + "p50":0, + "p75":0, + "p95":40, + "p98":40, + "p99":40, + "p999":40 + }, + "system/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":2, + "mean":2, + "max":2, + "stddev":0, + "p50":2, + "p75":2, + "p95":2, + "p98":2, + "p99":2, + "p999":2 + } + }, + "meters":{ + "org.apache.hugegraph.api.API.commit-succeed":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.hugegraph.api.API.expected-error":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.hugegraph.api.API.illegal-arg":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.hugegraph.api.API.unknown-error":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.errors":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + } + }, + "timers":{ + "org.apache.hugegraph.api.auth.AccessAPI.create":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.delete":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.get":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.list":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + ... + } +} +``` + +##### 1.1.2 Method & Url + +``` +http://localhost:8080/metrics/ + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +# HELP hugegraph_info +# TYPE hugegraph_info untyped +hugegraph_info{version="0.69",} 1.0 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity 1000000 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire 600000 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits 0 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss 0 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size 0 +# HELP org_apache_hugegraph_backend_cache_Cache_instances +# TYPE org_apache_hugegraph_backend_cache_Cache_instances gauge +org_apache_hugegraph_backend_cache_Cache_instances 7 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity 10000 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size 17 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity 10000 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size 17 +... +``` + +### 1.2 获取Gauges指标 + +##### Method & Url + +``` +http://localhost:8080/metrics/gauges + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { + "value": 1000000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.instances": { + "value": 7 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { + "value": 10000000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.server.RestServer.max-write-threads": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.pending-tasks": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.workers": { + "value": 4 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { + "value": 9.227692E8 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { + "value": 1.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { + "value": 1845538400 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { + "value": 0 + } +} +``` + +### 1.3 获取Counters指标 + +##### Method & Url + +``` +GET http://localhost:8080/metrics/counters + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "favicon.ico/GET/FAILED_COUNTER": { + "count": 1 + }, + "favicon.ico/GET/TOTAL_COUNTER": { + "count": 1 + }, + "metrics//GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics//GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/POST/FAILED_COUNTER": { + "count": 1 + }, + "metrics/POST/TOTAL_COUNTER": { + "count": 1 + }, + "metrics/backend/GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics/backend/GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/gauges/GET/SUCCESS_COUNTER": { + "count": 1 + }, + "metrics/gauges/GET/TOTAL_COUNTER": { + "count": 1 + }, + "metrics/statistics/GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics/statistics/GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/system/GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics/system/GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/timers/GET/SUCCESS_COUNTER": { + "count": 1 + }, + "metrics/timers/GET/TOTAL_COUNTER": { + "count": 1 + }, + "system/GET/FAILED_COUNTER": { + "count": 1 + }, + "system/GET/TOTAL_COUNTER": { + "count": 1 + } +} +``` + +### 1.4 获取histograms指标 + +##### Method & Url + +``` +GET http://localhost:8080/metrics/gauges + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 1, + "mean": 1.0, + "max": 1, + "stddev": 0.0, + "p50": 1.0, + "p75": 1.0, + "p95": 1.0, + "p98": 1.0, + "p99": 1.0, + "p999": 1.0 + }, + "metrics//GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 10, + "mean": 10.0, + "max": 10, + "stddev": 0.0, + "p50": 10.0, + "p75": 10.0, + "p95": 10.0, + "p98": 10.0, + "p99": 10.0, + "p999": 10.0 + }, + "metrics/POST/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 21, + "mean": 21.0, + "max": 21, + "stddev": 0.0, + "p50": 21.0, + "p75": 21.0, + "p95": 21.0, + "p98": 21.0, + "p99": 21.0, + "p999": 21.0 + }, + "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 6, + "mean": 12.6852124529148, + "max": 20, + "stddev": 6.992918475157571, + "p50": 6.0, + "p75": 20.0, + "p95": 20.0, + "p98": 20.0, + "p99": 20.0, + "p999": 20.0 + }, + "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 7, + "mean": 7.0, + "max": 7, + "stddev": 0.0, + "p50": 7.0, + "p75": 7.0, + "p95": 7.0, + "p98": 7.0, + "p99": 7.0, + "p999": 7.0 + }, + "metrics/statistics/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 1, + "mean": 1.4551211076264199, + "max": 2, + "stddev": 0.49798181193626, + "p50": 1.0, + "p75": 2.0, + "p95": 2.0, + "p98": 2.0, + "p99": 2.0, + "p999": 2.0 + }, + "metrics/system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 0, + "mean": 8.942674506664073, + "max": 40, + "stddev": 16.665399873223066, + "p50": 0.0, + "p75": 0.0, + "p95": 40.0, + "p98": 40.0, + "p99": 40.0, + "p999": 40.0 + }, + "metrics/timers/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 3, + "mean": 3.0, + "max": 3, + "stddev": 0.0, + "p50": 3.0, + "p75": 3.0, + "p95": 3.0, + "p98": 3.0, + "p99": 3.0, + "p999": 3.0 + }, + "system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 2, + "mean": 2.0, + "max": 2, + "stddev": 0.0, + "p50": 2.0, + "p75": 2.0, + "p95": 2.0, + "p98": 2.0, + "p99": 2.0, + "p999": 2.0 + } +} +``` + +### 1.5 获取meters指标 + +##### Method & Url + +``` +GET http://localhost:8080/metrics/meters + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "org.apache.hugegraph.api.API.commit-succeed": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.expected-error": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.illegal-arg": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.unknown-error": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.errors": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + } +} +``` + +### 1.6 获取timers指标 + +##### Method & Url + +``` +GET http://localhost:8080/metrics/timers + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "org.apache.hugegraph.api.auth.AccessAPI.create": { + "count": 0, + "min": 0.0, + "mean": 0.0, + "max": 0.0, + "stddev": 0.0, + "p50": 0.0, + "p75": 0.0, + "p95": 0.0, + "p98": 0.0, + "p99": 0.0, + "p999": 0.0, + "duration_unit": "milliseconds", + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.delete": { + "count": 0, + "min": 0.0, + "mean": 0.0, + "max": 0.0, + "stddev": 0.0, + "p50": 0.0, + "p75": 0.0, + "p95": 0.0, + "p98": 0.0, + "p99": 0.0, + "p999": 0.0, + "duration_unit": "milliseconds", + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "calls/second" + }, + + ... + +} +``` + +## 2.统计指标 + +##### Params + +- type：如果传值为json，则以json格式返回，否则以Promethaus格式返回。 + +##### 2.1 Method & Url + +``` +GET http://localhost:8080/metrics/statistics +``` + +##### Response Status + +```json +# HELP hugegraph_info +# TYPE hugegraph_info untyped +hugegraph_info{version="0.69",} 1.0 +# HELP metrics_POST +# TYPE metrics_POST gauge +metrics_POST{name=FAILED_REQUEST,} 1 +metrics_POST{name=MEAN_RESPONSE_TIME,} 21.0 +metrics_POST{name=MAX_RESPONSE_TIME,} 21 +metrics_POST{name=SUCCESS_REQUEST,} 0 +metrics_POST{name=TOTAL_REQUEST,} 1 +# HELP metrics_backend_GET +# TYPE metrics_backend_GET gauge +metrics_backend_GET{name=FAILED_REQUEST,} 0 +metrics_backend_GET{name=MEAN_RESPONSE_TIME,} 12.6852124529148 +metrics_backend_GET{name=MAX_RESPONSE_TIME,} 20 +metrics_backend_GET{name=SUCCESS_REQUEST,} 2 +metrics_backend_GET{name=TOTAL_REQUEST,} 2 +# HELP system_GET +# TYPE system_GET gauge +system_GET{name=FAILED_REQUEST,} 1 +system_GET{name=MEAN_RESPONSE_TIME,} 2.0 +system_GET{name=MAX_RESPONSE_TIME,} 2 +system_GET{name=SUCCESS_REQUEST,} 0 +system_GET{name=TOTAL_REQUEST,} 1 +# HELP metrics_gauges_GET +# TYPE metrics_gauges_GET gauge +metrics_gauges_GET{name=FAILED_REQUEST,} 0 +metrics_gauges_GET{name=MEAN_RESPONSE_TIME,} 7.0 +metrics_gauges_GET{name=MAX_RESPONSE_TIME,} 7 +metrics_gauges_GET{name=SUCCESS_REQUEST,} 1 +metrics_gauges_GET{name=TOTAL_REQUEST,} 1 +# HELP favicon.ico_GET +# TYPE favicon.ico_GET gauge +favicon.ico_GET{name=FAILED_REQUEST,} 1 +favicon.ico_GET{name=MEAN_RESPONSE_TIME,} 1.0 +favicon.ico_GET{name=MAX_RESPONSE_TIME,} 1 +favicon.ico_GET{name=SUCCESS_REQUEST,} 0 +favicon.ico_GET{name=TOTAL_REQUEST,} 1 +# HELP metrics__GET +# TYPE metrics__GET gauge +metrics__GET{name=FAILED_REQUEST,} 0 +metrics__GET{name=MEAN_RESPONSE_TIME,} 10.0 +metrics__GET{name=MAX_RESPONSE_TIME,} 10 +metrics__GET{name=SUCCESS_REQUEST,} 2 +metrics__GET{name=TOTAL_REQUEST,} 2 +# HELP metrics_system_GET +# TYPE metrics_system_GET gauge +metrics_system_GET{name=FAILED_REQUEST,} 0 +metrics_system_GET{name=MEAN_RESPONSE_TIME,} 8.942674506664073 +metrics_system_GET{name=MAX_RESPONSE_TIME,} 40 +metrics_system_GET{name=SUCCESS_REQUEST,} 2 +metrics_system_GET{name=TOTAL_REQUEST,} 2 + +``` + +##### Response Body + +```json +200 +``` + +##### 2.2 Method & Url + +``` +GET http://localhost:8080/metrics/statistics?type=json +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "metrics/POST":{ + "FAILED_REQUEST":1, + "MEAN_RESPONSE_TIME":21, + "MAX_RESPONSE_TIME":21, + "SUCCESS_REQUEST":0, + "TOTAL_REQUEST":1 + }, + "metrics/backend/GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":12.6852124529148, + "MAX_RESPONSE_TIME":20, + "SUCCESS_REQUEST":2, + "TOTAL_REQUEST":2 + }, + "system/GET":{ + "FAILED_REQUEST":1, + "MEAN_RESPONSE_TIME":2, + "MAX_RESPONSE_TIME":2, + "SUCCESS_REQUEST":0, + "TOTAL_REQUEST":1 + }, + "metrics/gauges/GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":7, + "MAX_RESPONSE_TIME":7, + "SUCCESS_REQUEST":1, + "TOTAL_REQUEST":1 + }, + "favicon.ico/GET":{ + "FAILED_REQUEST":1, + "MEAN_RESPONSE_TIME":1, + "MAX_RESPONSE_TIME":1, + "SUCCESS_REQUEST":0, + "TOTAL_REQUEST":1 + }, + "metrics//GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":10, + "MAX_RESPONSE_TIME":10, + "SUCCESS_REQUEST":2, + "TOTAL_REQUEST":2 + }, + "metrics/system/GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":8.942674506664073, + "MAX_RESPONSE_TIME":40, + "SUCCESS_REQUEST":2, + "TOTAL_REQUEST":2 + } +} +``` + + + +## 3.系统指标 + +系统指标主要返回机器运行指标，如内存、线程等信息。 + +##### Method & Url + +``` +GET http://localhost:8080/metrics/system +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "basic": { + "mem": 1010, + "mem_total": 911, + "mem_used": 239, + "mem_free": 671, + "mem_unit": "MB", + "processors": 20, + "uptime": 137503, + "systemload_average": -1.0 + }, + "heap": { + "committed": 911, + "init": 254, + "used": 239, + "max": 3596 + }, + "nonheap": { + "committed": 98, + "init": 2, + "used": 95, + "max": 0 + }, + "thread": { + "peak": 82, + "daemon": 34, + "total_started": 108, + "count": 82 + }, + "class_loading": { + "count": 11495, + "loaded": 11495, + "unloaded": 0 + }, + "garbage_collector": { + "ps_scavenge_count": 16, + "ps_scavenge_time": 155, + "ps_marksweep_count": 3, + "ps_marksweep_time": 494, + "time_unit": "ms" + } +} +``` + + + +## 4.后端指标 + +hugeGraph支持多种后端存储，后端指标包括内存、磁盘等信息。 + +##### Method & Url + +``` +GET http://localhost:8080/metrics/backend +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "hugegraph": { + "backend": "rocksdb", + "nodes": 1, + "cluster_id": "local", + "servers": { + "local": { + "mem_unit": "MB", + "disk_unit": "GB", + "mem_used": 0.1, + "mem_used_readable": "103.53 KB", + "disk_usage": 0.03, + "disk_usage_readable": "29.03 KB", + "block_cache_usage": 0.00359344482421875, + "block_cache_pinned_usage": 0.00359344482421875, + "block_cache_capacity": 304.0, + "estimate_table_readers_mem": 0.019697189331054688, + "size_all_mem_tables": 0.07421875, + "cur_size_all_mem_tables": 0.07421875, + "estimate_live_data_size": 5.536526441574097E-5, + "total_sst_files_size": 5.536526441574097E-5, + "live_sst_files_size": 5.536526441574097E-5, + "estimate_pending_compaction_bytes": 0.0, + "estimate_num_keys": 0, + "num_entries_active_mem_table": 0, + "num_entries_imm_mem_tables": 0, + "num_deletes_active_mem_table": 0, + "num_deletes_imm_mem_tables": 0, + "num_running_flushes": 0, + "mem_table_flush_pending": 0, + "num_running_compactions": 0, + "compaction_pending": 0, + "num_immutable_mem_table": 0, + "num_snapshots": 0, + "oldest_snapshot_time": 0, + "num_live_versions": 38, + "current_super_version_number": 38 + } + } + } +} +``` + diff --git a/content/en/docs/clients/restful-api/_index.md b/content/en/docs/clients/restful-api/_index.md index 9265a3450..75d655631 100644 --- a/content/en/docs/clients/restful-api/_index.md +++ b/content/en/docs/clients/restful-api/_index.md @@ -42,4 +42,6 @@ HugeGraph-Server provides interfaces for clients to operate on graphs based on t [comment]: <> (- [Authentication](restful-api/auth.md)) +[comment]: <> (- [Metrics](restful-api/metrics.md)) + [comment]: <> (- [Other](restful-api/other.md)) diff --git a/content/en/docs/clients/restful-api/metrics.md b/content/en/docs/clients/restful-api/metrics.md new file mode 100644 index 000000000..b1ae0aa77 --- /dev/null +++ b/content/en/docs/clients/restful-api/metrics.md @@ -0,0 +1,1315 @@ +--- +title: "Metrics API" +linkTitle: "Metrics" +weight: 1 + +--- + +HugeGraph provides metrics info, including basic metrics, statistical metrics, system metrics, and backend metrics. + + +## 1. Basic Metrics + +### 1.1 Get All Basic Metrics + + +##### Params + +- type：If the passed value is JSON, it is returned in JSON format, otherwise it is returned in Promethaus format. + +##### 1.1.1 Method & Url + +``` +http://localhost:8080/metrics/?type=json +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "gauges":{ + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity":{ + "value":1000000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.instances":{ + "value":7 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity":{ + "value":10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size":{ + "value":17 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity":{ + "value":10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size":{ + "value":17 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity":{ + "value":10240 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity":{ + "value":10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity":{ + "value":10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity":{ + "value":10000000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire":{ + "value":600000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss":{ + "value":0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size":{ + "value":0 + }, + "org.apache.hugegraph.server.RestServer.max-write-threads":{ + "value":0 + }, + "org.apache.hugegraph.task.TaskManager.pending-tasks":{ + "value":0 + }, + "org.apache.hugegraph.task.TaskManager.workers":{ + "value":4 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty":{ + "value":922769200 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count":{ + "value":0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate":{ + "value":1 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count":{ + "value":2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time":{ + "value":1845538400 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions":{ + "value":0 + } + }, + "counters":{ + "favicon.ico/GET/FAILED_COUNTER":{ + "count":1 + }, + "favicon.ico/GET/TOTAL_COUNTER":{ + "count":1 + }, + "metrics/POST/FAILED_COUNTER":{ + "count":1 + }, + "metrics/POST/TOTAL_COUNTER":{ + "count":1 + }, + "metrics/backend/GET/SUCCESS_COUNTER":{ + "count":2 + }, + "metrics/backend/GET/TOTAL_COUNTER":{ + "count":2 + }, + "metrics/gauges/GET/SUCCESS_COUNTER":{ + "count":1 + }, + "metrics/gauges/GET/TOTAL_COUNTER":{ + "count":1 + }, + "metrics/system/GET/SUCCESS_COUNTER":{ + "count":2 + }, + "metrics/system/GET/TOTAL_COUNTER":{ + "count":2 + }, + "system/GET/FAILED_COUNTER":{ + "count":1 + }, + "system/GET/TOTAL_COUNTER":{ + "count":1 + } + }, + "histograms":{ + "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":1, + "mean":1, + "max":1, + "stddev":0, + "p50":1, + "p75":1, + "p95":1, + "p98":1, + "p99":1, + "p999":1 + }, + "metrics/POST/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":21, + "mean":21, + "max":21, + "stddev":0, + "p50":21, + "p75":21, + "p95":21, + "p98":21, + "p99":21, + "p999":21 + }, + "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":2, + "min":6, + "mean":12.6852124529148, + "max":20, + "stddev":6.992918475157571, + "p50":6, + "p75":20, + "p95":20, + "p98":20, + "p99":20, + "p999":20 + }, + "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":7, + "mean":7, + "max":7, + "stddev":0, + "p50":7, + "p75":7, + "p95":7, + "p98":7, + "p99":7, + "p999":7 + }, + "metrics/system/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":2, + "min":0, + "mean":8.942674506664073, + "max":40, + "stddev":16.665399873223066, + "p50":0, + "p75":0, + "p95":40, + "p98":40, + "p99":40, + "p999":40 + }, + "system/GET/RESPONSE_TIME_HISTOGRAM":{ + "count":1, + "min":2, + "mean":2, + "max":2, + "stddev":0, + "p50":2, + "p75":2, + "p95":2, + "p98":2, + "p99":2, + "p999":2 + } + }, + "meters":{ + "org.apache.hugegraph.api.API.commit-succeed":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.hugegraph.api.API.expected-error":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.hugegraph.api.API.illegal-arg":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.hugegraph.api.API.unknown-error":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.errors":{ + "count":0, + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"events/second" + } + }, + "timers":{ + "org.apache.hugegraph.api.auth.AccessAPI.create":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.delete":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.get":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.list":{ + "count":0, + "min":0, + "mean":0, + "max":0, + "stddev":0, + "p50":0, + "p75":0, + "p95":0, + "p98":0, + "p99":0, + "p999":0, + "duration_unit":"milliseconds", + "mean_rate":0, + "m15_rate":0, + "m5_rate":0, + "m1_rate":0, + "rate_unit":"calls/second" + }, + ... + } +} +``` + +##### 1.1.2 Method & Url + +``` +http://localhost:8080/metrics/ + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +# HELP hugegraph_info +# TYPE hugegraph_info untyped +hugegraph_info{version="0.69",} 1.0 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity 1000000 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_expire 600000 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_hits 0 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_miss 0 +# HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size +# TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size gauge +org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_size 0 +# HELP org_apache_hugegraph_backend_cache_Cache_instances +# TYPE org_apache_hugegraph_backend_cache_Cache_instances gauge +org_apache_hugegraph_backend_cache_Cache_instances 7 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_capacity 10000 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_expire 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_hits 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_miss 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size gauge +org_apache_hugegraph_backend_cache_Cache_schema_id_hugegraph_size 17 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_capacity 10000 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_expire 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_hits 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_miss 0 +# HELP org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size +# TYPE org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size gauge +org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size 17 +... +``` + +### 1.2 Get Gauges Metrics + +##### Method & Url + +``` +http://localhost:8080/metrics/gauges + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { + "value": 1000000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.instances": { + "value": 7 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { + "value": 10000000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.server.RestServer.max-write-threads": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.pending-tasks": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.workers": { + "value": 4 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { + "value": 9.227692E8 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { + "value": 1.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { + "value": 1845538400 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { + "value": 0 + } +} +``` + +### 1.3 Get Counters Metrics + +##### Method & Url + +``` +GET http://localhost:8080/metrics/counters + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "favicon.ico/GET/FAILED_COUNTER": { + "count": 1 + }, + "favicon.ico/GET/TOTAL_COUNTER": { + "count": 1 + }, + "metrics//GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics//GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/POST/FAILED_COUNTER": { + "count": 1 + }, + "metrics/POST/TOTAL_COUNTER": { + "count": 1 + }, + "metrics/backend/GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics/backend/GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/gauges/GET/SUCCESS_COUNTER": { + "count": 1 + }, + "metrics/gauges/GET/TOTAL_COUNTER": { + "count": 1 + }, + "metrics/statistics/GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics/statistics/GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/system/GET/SUCCESS_COUNTER": { + "count": 2 + }, + "metrics/system/GET/TOTAL_COUNTER": { + "count": 2 + }, + "metrics/timers/GET/SUCCESS_COUNTER": { + "count": 1 + }, + "metrics/timers/GET/TOTAL_COUNTER": { + "count": 1 + }, + "system/GET/FAILED_COUNTER": { + "count": 1 + }, + "system/GET/TOTAL_COUNTER": { + "count": 1 + } +} +``` + +### 1.4 Get Histograms Metrics + +##### Method & Url + +``` +GET http://localhost:8080/metrics/gauges + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 1, + "mean": 1.0, + "max": 1, + "stddev": 0.0, + "p50": 1.0, + "p75": 1.0, + "p95": 1.0, + "p98": 1.0, + "p99": 1.0, + "p999": 1.0 + }, + "metrics//GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 10, + "mean": 10.0, + "max": 10, + "stddev": 0.0, + "p50": 10.0, + "p75": 10.0, + "p95": 10.0, + "p98": 10.0, + "p99": 10.0, + "p999": 10.0 + }, + "metrics/POST/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 21, + "mean": 21.0, + "max": 21, + "stddev": 0.0, + "p50": 21.0, + "p75": 21.0, + "p95": 21.0, + "p98": 21.0, + "p99": 21.0, + "p999": 21.0 + }, + "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 6, + "mean": 12.6852124529148, + "max": 20, + "stddev": 6.992918475157571, + "p50": 6.0, + "p75": 20.0, + "p95": 20.0, + "p98": 20.0, + "p99": 20.0, + "p999": 20.0 + }, + "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 7, + "mean": 7.0, + "max": 7, + "stddev": 0.0, + "p50": 7.0, + "p75": 7.0, + "p95": 7.0, + "p98": 7.0, + "p99": 7.0, + "p999": 7.0 + }, + "metrics/statistics/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 1, + "mean": 1.4551211076264199, + "max": 2, + "stddev": 0.49798181193626, + "p50": 1.0, + "p75": 2.0, + "p95": 2.0, + "p98": 2.0, + "p99": 2.0, + "p999": 2.0 + }, + "metrics/system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 0, + "mean": 8.942674506664073, + "max": 40, + "stddev": 16.665399873223066, + "p50": 0.0, + "p75": 0.0, + "p95": 40.0, + "p98": 40.0, + "p99": 40.0, + "p999": 40.0 + }, + "metrics/timers/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 3, + "mean": 3.0, + "max": 3, + "stddev": 0.0, + "p50": 3.0, + "p75": 3.0, + "p95": 3.0, + "p98": 3.0, + "p99": 3.0, + "p999": 3.0 + }, + "system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 2, + "mean": 2.0, + "max": 2, + "stddev": 0.0, + "p50": 2.0, + "p75": 2.0, + "p95": 2.0, + "p98": 2.0, + "p99": 2.0, + "p999": 2.0 + } +} +``` + +### 1.5 Get Meters Metrics + +##### Method & Url + +``` +GET http://localhost:8080/metrics/meters + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "org.apache.hugegraph.api.API.commit-succeed": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.expected-error": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.illegal-arg": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.unknown-error": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.errors": { + "count": 0, + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "events/second" + } +} +``` + +### 1.6 Get Timers Metrics + +##### Method & Url + +``` +GET http://localhost:8080/metrics/timers + +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "org.apache.hugegraph.api.auth.AccessAPI.create": { + "count": 0, + "min": 0.0, + "mean": 0.0, + "max": 0.0, + "stddev": 0.0, + "p50": 0.0, + "p75": 0.0, + "p95": 0.0, + "p98": 0.0, + "p99": 0.0, + "p999": 0.0, + "duration_unit": "milliseconds", + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.delete": { + "count": 0, + "min": 0.0, + "mean": 0.0, + "max": 0.0, + "stddev": 0.0, + "p50": 0.0, + "p75": 0.0, + "p95": 0.0, + "p98": 0.0, + "p99": 0.0, + "p999": 0.0, + "duration_unit": "milliseconds", + "mean_rate": 0.0, + "m15_rate": 0.0, + "m5_rate": 0.0, + "m1_rate": 0.0, + "rate_unit": "calls/second" + }, + + ... + +} +``` + +## 2.Statistical Metrics + +##### Params + +- type：If the passed value is JSON, it is returned in JSON format, otherwise it is returned in +Promethaus format. + +##### 2.1 Method & Url + +``` +GET http://localhost:8080/metrics/statistics +``` + +##### Response Status + +```json +# HELP hugegraph_info +# TYPE hugegraph_info untyped +hugegraph_info{version="0.69",} 1.0 +# HELP metrics_POST +# TYPE metrics_POST gauge +metrics_POST{name=FAILED_REQUEST,} 1 +metrics_POST{name=MEAN_RESPONSE_TIME,} 21.0 +metrics_POST{name=MAX_RESPONSE_TIME,} 21 +metrics_POST{name=SUCCESS_REQUEST,} 0 +metrics_POST{name=TOTAL_REQUEST,} 1 +# HELP metrics_backend_GET +# TYPE metrics_backend_GET gauge +metrics_backend_GET{name=FAILED_REQUEST,} 0 +metrics_backend_GET{name=MEAN_RESPONSE_TIME,} 12.6852124529148 +metrics_backend_GET{name=MAX_RESPONSE_TIME,} 20 +metrics_backend_GET{name=SUCCESS_REQUEST,} 2 +metrics_backend_GET{name=TOTAL_REQUEST,} 2 +# HELP system_GET +# TYPE system_GET gauge +system_GET{name=FAILED_REQUEST,} 1 +system_GET{name=MEAN_RESPONSE_TIME,} 2.0 +system_GET{name=MAX_RESPONSE_TIME,} 2 +system_GET{name=SUCCESS_REQUEST,} 0 +system_GET{name=TOTAL_REQUEST,} 1 +# HELP metrics_gauges_GET +# TYPE metrics_gauges_GET gauge +metrics_gauges_GET{name=FAILED_REQUEST,} 0 +metrics_gauges_GET{name=MEAN_RESPONSE_TIME,} 7.0 +metrics_gauges_GET{name=MAX_RESPONSE_TIME,} 7 +metrics_gauges_GET{name=SUCCESS_REQUEST,} 1 +metrics_gauges_GET{name=TOTAL_REQUEST,} 1 +# HELP favicon.ico_GET +# TYPE favicon.ico_GET gauge +favicon.ico_GET{name=FAILED_REQUEST,} 1 +favicon.ico_GET{name=MEAN_RESPONSE_TIME,} 1.0 +favicon.ico_GET{name=MAX_RESPONSE_TIME,} 1 +favicon.ico_GET{name=SUCCESS_REQUEST,} 0 +favicon.ico_GET{name=TOTAL_REQUEST,} 1 +# HELP metrics__GET +# TYPE metrics__GET gauge +metrics__GET{name=FAILED_REQUEST,} 0 +metrics__GET{name=MEAN_RESPONSE_TIME,} 10.0 +metrics__GET{name=MAX_RESPONSE_TIME,} 10 +metrics__GET{name=SUCCESS_REQUEST,} 2 +metrics__GET{name=TOTAL_REQUEST,} 2 +# HELP metrics_system_GET +# TYPE metrics_system_GET gauge +metrics_system_GET{name=FAILED_REQUEST,} 0 +metrics_system_GET{name=MEAN_RESPONSE_TIME,} 8.942674506664073 +metrics_system_GET{name=MAX_RESPONSE_TIME,} 40 +metrics_system_GET{name=SUCCESS_REQUEST,} 2 +metrics_system_GET{name=TOTAL_REQUEST,} 2 + +``` + +##### Response Body + +```json +200 +``` + +##### 2.2 Method & Url + +``` +GET http://localhost:8080/metrics/statistics?type=json +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "metrics/POST":{ + "FAILED_REQUEST":1, + "MEAN_RESPONSE_TIME":21, + "MAX_RESPONSE_TIME":21, + "SUCCESS_REQUEST":0, + "TOTAL_REQUEST":1 + }, + "metrics/backend/GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":12.6852124529148, + "MAX_RESPONSE_TIME":20, + "SUCCESS_REQUEST":2, + "TOTAL_REQUEST":2 + }, + "system/GET":{ + "FAILED_REQUEST":1, + "MEAN_RESPONSE_TIME":2, + "MAX_RESPONSE_TIME":2, + "SUCCESS_REQUEST":0, + "TOTAL_REQUEST":1 + }, + "metrics/gauges/GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":7, + "MAX_RESPONSE_TIME":7, + "SUCCESS_REQUEST":1, + "TOTAL_REQUEST":1 + }, + "favicon.ico/GET":{ + "FAILED_REQUEST":1, + "MEAN_RESPONSE_TIME":1, + "MAX_RESPONSE_TIME":1, + "SUCCESS_REQUEST":0, + "TOTAL_REQUEST":1 + }, + "metrics//GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":10, + "MAX_RESPONSE_TIME":10, + "SUCCESS_REQUEST":2, + "TOTAL_REQUEST":2 + }, + "metrics/system/GET":{ + "FAILED_REQUEST":0, + "MEAN_RESPONSE_TIME":8.942674506664073, + "MAX_RESPONSE_TIME":40, + "SUCCESS_REQUEST":2, + "TOTAL_REQUEST":2 + } +} +``` + + + +## 3.System Metrics + +System metrics mainly return the machine metrics, such as memory, threads, and other +information. + +##### Method & Url + +``` +GET http://localhost:8080/metrics/system +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "basic": { + "mem": 1010, + "mem_total": 911, + "mem_used": 239, + "mem_free": 671, + "mem_unit": "MB", + "processors": 20, + "uptime": 137503, + "systemload_average": -1.0 + }, + "heap": { + "committed": 911, + "init": 254, + "used": 239, + "max": 3596 + }, + "nonheap": { + "committed": 98, + "init": 2, + "used": 95, + "max": 0 + }, + "thread": { + "peak": 82, + "daemon": 34, + "total_started": 108, + "count": 82 + }, + "class_loading": { + "count": 11495, + "loaded": 11495, + "unloaded": 0 + }, + "garbage_collector": { + "ps_scavenge_count": 16, + "ps_scavenge_time": 155, + "ps_marksweep_count": 3, + "ps_marksweep_time": 494, + "time_unit": "ms" + } +} +``` + + + +## 4.Backend Metrics + +HugeGraph supports multiple backend storage, with backend metrics including memory, disk, and other information. +##### Method & Url + +``` +GET http://localhost:8080/metrics/backend +``` + +##### Response Status + +```json +200 +``` + +##### Response Body + +```json +{ + "hugegraph": { + "backend": "rocksdb", + "nodes": 1, + "cluster_id": "local", + "servers": { + "local": { + "mem_unit": "MB", + "disk_unit": "GB", + "mem_used": 0.1, + "mem_used_readable": "103.53 KB", + "disk_usage": 0.03, + "disk_usage_readable": "29.03 KB", + "block_cache_usage": 0.00359344482421875, + "block_cache_pinned_usage": 0.00359344482421875, + "block_cache_capacity": 304.0, + "estimate_table_readers_mem": 0.019697189331054688, + "size_all_mem_tables": 0.07421875, + "cur_size_all_mem_tables": 0.07421875, + "estimate_live_data_size": 5.536526441574097E-5, + "total_sst_files_size": 5.536526441574097E-5, + "live_sst_files_size": 5.536526441574097E-5, + "estimate_pending_compaction_bytes": 0.0, + "estimate_num_keys": 0, + "num_entries_active_mem_table": 0, + "num_entries_imm_mem_tables": 0, + "num_deletes_active_mem_table": 0, + "num_deletes_imm_mem_tables": 0, + "num_running_flushes": 0, + "mem_table_flush_pending": 0, + "num_running_compactions": 0, + "compaction_pending": 0, + "num_immutable_mem_table": 0, + "num_snapshots": 0, + "oldest_snapshot_time": 0, + "num_live_versions": 38, + "current_super_version_number": 38 + } + } + } +} +``` + From dfca306e2847e92a67c1e82a881b4605aa19cec6 Mon Sep 17 00:00:00 2001 From: 1289220708 <1289220708@qq.com> Date: Sun, 29 Oct 2023 11:55:20 +0800 Subject: [PATCH 2/5] =?UTF-8?q?feat(website):=20add=20metric=20api=20doc?= =?UTF-8?q?=EF=BC=8Cformat=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../cn/docs/clients/restful-api/metrics.md | 1280 +++++++++-------- .../en/docs/clients/restful-api/metrics.md | 1279 ++++++++-------- 2 files changed, 1311 insertions(+), 1248 deletions(-) diff --git a/content/cn/docs/clients/restful-api/metrics.md b/content/cn/docs/clients/restful-api/metrics.md index 9a4e8e0b4..b523a6689 100644 --- a/content/cn/docs/clients/restful-api/metrics.md +++ b/content/cn/docs/clients/restful-api/metrics.md @@ -5,17 +5,15 @@ weight: 1 --- -HugeGraph 提供Metrics 信息披露，包括：基础指标、统计指标、系统指标、后端指标。 - +HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。 ## 1. 基础指标 ### 1.1 获取所有基础指标 - ##### Params -- type：如果传值为json，则以json格式返回，否则以Promethaus格式返回。 +- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。 ##### 1.1.1 Method & Url @@ -33,409 +31,409 @@ http://localhost:8080/metrics/?type=json ```json { - "gauges":{ - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity":{ - "value":1000000 + "gauges": { + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { + "value": 1000000 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.instances":{ - "value":7 + "org.apache.hugegraph.backend.cache.Cache.instances": { + "value": 7 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity":{ - "value":10000 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { + "value": 10000 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size":{ - "value":17 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { + "value": 17 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity":{ - "value":10000 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { + "value": 10000 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size":{ - "value":17 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { + "value": 17 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity":{ - "value":10240 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { + "value": 10240 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity":{ - "value":10240 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { + "value": 10240 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity":{ - "value":10240 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { + "value": 10240 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity":{ - "value":10000000 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { + "value": 10000000 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.server.RestServer.max-write-threads":{ - "value":0 + "org.apache.hugegraph.server.RestServer.max-write-threads": { + "value": 0 }, - "org.apache.hugegraph.task.TaskManager.pending-tasks":{ - "value":0 + "org.apache.hugegraph.task.TaskManager.pending-tasks": { + "value": 0 }, - "org.apache.hugegraph.task.TaskManager.workers":{ - "value":4 + "org.apache.hugegraph.task.TaskManager.workers": { + "value": 4 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty":{ - "value":922769200 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { + "value": 922769200 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate":{ - "value":1 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { + "value": 1 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time":{ - "value":1845538400 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { + "value": 1845538400 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { + "value": 0 } }, - "counters":{ - "favicon.ico/GET/FAILED_COUNTER":{ - "count":1 + "counters": { + "favicon.ico/GET/FAILED_COUNTER": { + "count": 1 }, - "favicon.ico/GET/TOTAL_COUNTER":{ - "count":1 + "favicon.ico/GET/TOTAL_COUNTER": { + "count": 1 }, - "metrics/POST/FAILED_COUNTER":{ - "count":1 + "metrics/POST/FAILED_COUNTER": { + "count": 1 }, - "metrics/POST/TOTAL_COUNTER":{ - "count":1 + "metrics/POST/TOTAL_COUNTER": { + "count": 1 }, - "metrics/backend/GET/SUCCESS_COUNTER":{ - "count":2 + "metrics/backend/GET/SUCCESS_COUNTER": { + "count": 2 }, - "metrics/backend/GET/TOTAL_COUNTER":{ - "count":2 + "metrics/backend/GET/TOTAL_COUNTER": { + "count": 2 }, - "metrics/gauges/GET/SUCCESS_COUNTER":{ - "count":1 + "metrics/gauges/GET/SUCCESS_COUNTER": { + "count": 1 }, - "metrics/gauges/GET/TOTAL_COUNTER":{ - "count":1 + "metrics/gauges/GET/TOTAL_COUNTER": { + "count": 1 }, - "metrics/system/GET/SUCCESS_COUNTER":{ - "count":2 + "metrics/system/GET/SUCCESS_COUNTER": { + "count": 2 }, - "metrics/system/GET/TOTAL_COUNTER":{ - "count":2 + "metrics/system/GET/TOTAL_COUNTER": { + "count": 2 }, - "system/GET/FAILED_COUNTER":{ - "count":1 + "system/GET/FAILED_COUNTER": { + "count": 1 }, - "system/GET/TOTAL_COUNTER":{ - "count":1 + "system/GET/TOTAL_COUNTER": { + "count": 1 } }, - "histograms":{ - "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":1, - "mean":1, - "max":1, - "stddev":0, - "p50":1, - "p75":1, - "p95":1, - "p98":1, - "p99":1, - "p999":1 - }, - "metrics/POST/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":21, - "mean":21, - "max":21, - "stddev":0, - "p50":21, - "p75":21, - "p95":21, - "p98":21, - "p99":21, - "p999":21 - }, - "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":2, - "min":6, - "mean":12.6852124529148, - "max":20, - "stddev":6.992918475157571, - "p50":6, - "p75":20, - "p95":20, - "p98":20, - "p99":20, - "p999":20 - }, - "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":7, - "mean":7, - "max":7, - "stddev":0, - "p50":7, - "p75":7, - "p95":7, - "p98":7, - "p99":7, - "p999":7 - }, - "metrics/system/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":2, - "min":0, - "mean":8.942674506664073, - "max":40, - "stddev":16.665399873223066, - "p50":0, - "p75":0, - "p95":40, - "p98":40, - "p99":40, - "p999":40 - }, - "system/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":2, - "mean":2, - "max":2, - "stddev":0, - "p50":2, - "p75":2, - "p95":2, - "p98":2, - "p99":2, - "p999":2 + "histograms": { + "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 1, + "mean": 1, + "max": 1, + "stddev": 0, + "p50": 1, + "p75": 1, + "p95": 1, + "p98": 1, + "p99": 1, + "p999": 1 + }, + "metrics/POST/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 21, + "mean": 21, + "max": 21, + "stddev": 0, + "p50": 21, + "p75": 21, + "p95": 21, + "p98": 21, + "p99": 21, + "p999": 21 + }, + "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 6, + "mean": 12.6852124529148, + "max": 20, + "stddev": 6.992918475157571, + "p50": 6, + "p75": 20, + "p95": 20, + "p98": 20, + "p99": 20, + "p999": 20 + }, + "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 7, + "mean": 7, + "max": 7, + "stddev": 0, + "p50": 7, + "p75": 7, + "p95": 7, + "p98": 7, + "p99": 7, + "p999": 7 + }, + "metrics/system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 0, + "mean": 8.942674506664073, + "max": 40, + "stddev": 16.665399873223066, + "p50": 0, + "p75": 0, + "p95": 40, + "p98": 40, + "p99": 40, + "p999": 40 + }, + "system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 2, + "mean": 2, + "max": 2, + "stddev": 0, + "p50": 2, + "p75": 2, + "p95": 2, + "p98": 2, + "p99": 2, + "p999": 2 } }, - "meters":{ - "org.apache.hugegraph.api.API.commit-succeed":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.hugegraph.api.API.expected-error":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.hugegraph.api.API.illegal-arg":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.hugegraph.api.API.unknown-error":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.errors":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" + "meters": { + "org.apache.hugegraph.api.API.commit-succeed": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.expected-error": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.illegal-arg": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.unknown-error": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.errors": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" } }, - "timers":{ - "org.apache.hugegraph.api.auth.AccessAPI.create":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" - }, - "org.apache.hugegraph.api.auth.AccessAPI.delete":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" - }, - "org.apache.hugegraph.api.auth.AccessAPI.get":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" - }, - "org.apache.hugegraph.api.auth.AccessAPI.list":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" + "timers": { + "org.apache.hugegraph.api.auth.AccessAPI.create": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.delete": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.get": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.list": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" }, ... } @@ -460,7 +458,8 @@ http://localhost:8080/metrics/ ```json # HELP hugegraph_info # TYPE hugegraph_info untyped -hugegraph_info{version="0.69",} 1.0 +hugegraph_info{version="0.69", +} 1.0 # HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity # TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity gauge org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity 1000000 @@ -512,7 +511,7 @@ org_apache_hugegraph_backend_cache_Cache_schema_name_hugegraph_size 17 ... ``` -### 1.2 获取Gauges指标 +### 1.2 获取 Gauges 指标 ##### Method & Url @@ -531,175 +530,175 @@ http://localhost:8080/metrics/gauges ```json { - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { - "value": 1000000 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.instances": { - "value": 7 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { - "value": 10000 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { - "value": 17 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { - "value": 10000 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { - "value": 17 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { - "value": 10240 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { - "value": 10240 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { - "value": 10240 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { - "value": 10000000 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.server.RestServer.max-write-threads": { - "value": 0 - }, - "org.apache.hugegraph.task.TaskManager.pending-tasks": { - "value": 0 - }, - "org.apache.hugegraph.task.TaskManager.workers": { - "value": 4 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { - "value": 9.227692E8 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { - "value": 0.0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { - "value": 0.0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { - "value": 1.0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { - "value": 1845538400 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { - "value": 0 - } + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { + "value": 1000000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.instances": { + "value": 7 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { + "value": 10000000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.server.RestServer.max-write-threads": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.pending-tasks": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.workers": { + "value": 4 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { + "value": 9.227692E8 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { + "value": 1.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { + "value": 1845538400 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { + "value": 0 + } } ``` -### 1.3 获取Counters指标 +### 1.3 获取 Counters 指标 ##### Method & Url @@ -775,7 +774,7 @@ GET http://localhost:8080/metrics/counters } ``` -### 1.4 获取histograms指标 +### 1.4 获取 histograms 指标 ##### Method & Url @@ -914,7 +913,7 @@ GET http://localhost:8080/metrics/gauges } ``` -### 1.5 获取meters指标 +### 1.5 获取 meters 指标 ##### Method & Url @@ -976,7 +975,7 @@ GET http://localhost:8080/metrics/meters } ``` -### 1.6 获取timers指标 +### 1.6 获取 timers 指标 ##### Method & Url @@ -1033,9 +1032,7 @@ GET http://localhost:8080/metrics/timers "m1_rate": 0.0, "rate_unit": "calls/second" }, - ... - } ``` @@ -1043,7 +1040,7 @@ GET http://localhost:8080/metrics/timers ##### Params -- type：如果传值为json，则以json格式返回，否则以Promethaus格式返回。 +- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。 ##### 2.1 Method & Url @@ -1056,56 +1053,93 @@ GET http://localhost:8080/metrics/statistics ```json # HELP hugegraph_info # TYPE hugegraph_info untyped -hugegraph_info{version="0.69",} 1.0 +hugegraph_info{version="0.69", +} 1.0 # HELP metrics_POST # TYPE metrics_POST gauge metrics_POST{name=FAILED_REQUEST,} 1 metrics_POST{name=MEAN_RESPONSE_TIME,} 21.0 -metrics_POST{name=MAX_RESPONSE_TIME,} 21 -metrics_POST{name=SUCCESS_REQUEST,} 0 -metrics_POST{name=TOTAL_REQUEST,} 1 +metrics_POST{ +name=MAX_RESPONSE_TIME, +} 21 +metrics_POST{name=SUCCESS_REQUEST, +} 0 +metrics_POST{ +name=TOTAL_REQUEST, +} 1 # HELP metrics_backend_GET # TYPE metrics_backend_GET gauge -metrics_backend_GET{name=FAILED_REQUEST,} 0 -metrics_backend_GET{name=MEAN_RESPONSE_TIME,} 12.6852124529148 -metrics_backend_GET{name=MAX_RESPONSE_TIME,} 20 -metrics_backend_GET{name=SUCCESS_REQUEST,} 2 +metrics_backend_GET{name=FAILED_REQUEST, +} 0 +metrics_backend_GET{ +name=MEAN_RESPONSE_TIME, +} 12.6852124529148 +metrics_backend_GET{ +name=MAX_RESPONSE_TIME, +} 20 +metrics_backend_GET{ +name=SUCCESS_REQUEST, +} 2 metrics_backend_GET{name=TOTAL_REQUEST,} 2 # HELP system_GET # TYPE system_GET gauge system_GET{name=FAILED_REQUEST,} 1 system_GET{name=MEAN_RESPONSE_TIME,} 2.0 system_GET{name=MAX_RESPONSE_TIME,} 2 -system_GET{name=SUCCESS_REQUEST,} 0 -system_GET{name=TOTAL_REQUEST,} 1 +system_GET{ +name=SUCCESS_REQUEST, +} 0 +system_GET{name=TOTAL_REQUEST, +} 1 # HELP metrics_gauges_GET # TYPE metrics_gauges_GET gauge metrics_gauges_GET{name=FAILED_REQUEST,} 0 -metrics_gauges_GET{name=MEAN_RESPONSE_TIME,} 7.0 -metrics_gauges_GET{name=MAX_RESPONSE_TIME,} 7 -metrics_gauges_GET{name=SUCCESS_REQUEST,} 1 -metrics_gauges_GET{name=TOTAL_REQUEST,} 1 +metrics_gauges_GET{name=MEAN_RESPONSE_TIME, +} 7.0 +metrics_gauges_GET{ +name=MAX_RESPONSE_TIME, +} 7 +metrics_gauges_GET{ +name=SUCCESS_REQUEST, +} 1 +metrics_gauges_GET{ +name=TOTAL_REQUEST, +} 1 # HELP favicon.ico_GET # TYPE favicon.ico_GET gauge -favicon.ico_GET{name=FAILED_REQUEST,} 1 -favicon.ico_GET{name=MEAN_RESPONSE_TIME,} 1.0 +favicon.ico_GET{name=FAILED_REQUEST, +} 1 +favicon.ico_GET{ +name=MEAN_RESPONSE_TIME, +} 1.0 favicon.ico_GET{name=MAX_RESPONSE_TIME,} 1 favicon.ico_GET{name=SUCCESS_REQUEST,} 0 -favicon.ico_GET{name=TOTAL_REQUEST,} 1 +favicon.ico_GET{ +name=TOTAL_REQUEST, +} 1 # HELP metrics__GET # TYPE metrics__GET gauge metrics__GET{name=FAILED_REQUEST,} 0 metrics__GET{name=MEAN_RESPONSE_TIME,} 10.0 -metrics__GET{name=MAX_RESPONSE_TIME,} 10 -metrics__GET{name=SUCCESS_REQUEST,} 2 -metrics__GET{name=TOTAL_REQUEST,} 2 +metrics__GET{name=MAX_RESPONSE_TIME, +} 10 +metrics__GET{ +name=SUCCESS_REQUEST, +} 2 +metrics__GET{ +name=TOTAL_REQUEST, +} 2 # HELP metrics_system_GET # TYPE metrics_system_GET gauge metrics_system_GET{name=FAILED_REQUEST,} 0 -metrics_system_GET{name=MEAN_RESPONSE_TIME,} 8.942674506664073 -metrics_system_GET{name=MAX_RESPONSE_TIME,} 40 +metrics_system_GET{name=MEAN_RESPONSE_TIME, +} 8.942674506664073 +metrics_system_GET{ +name=MAX_RESPONSE_TIME, +} 40 metrics_system_GET{name=SUCCESS_REQUEST,} 2 -metrics_system_GET{name=TOTAL_REQUEST,} 2 +metrics_system_GET{name=TOTAL_REQUEST, +} 2 ``` @@ -1131,60 +1165,58 @@ GET http://localhost:8080/metrics/statistics?type=json ```json { - "metrics/POST":{ - "FAILED_REQUEST":1, - "MEAN_RESPONSE_TIME":21, - "MAX_RESPONSE_TIME":21, - "SUCCESS_REQUEST":0, - "TOTAL_REQUEST":1 - }, - "metrics/backend/GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":12.6852124529148, - "MAX_RESPONSE_TIME":20, - "SUCCESS_REQUEST":2, - "TOTAL_REQUEST":2 - }, - "system/GET":{ - "FAILED_REQUEST":1, - "MEAN_RESPONSE_TIME":2, - "MAX_RESPONSE_TIME":2, - "SUCCESS_REQUEST":0, - "TOTAL_REQUEST":1 - }, - "metrics/gauges/GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":7, - "MAX_RESPONSE_TIME":7, - "SUCCESS_REQUEST":1, - "TOTAL_REQUEST":1 - }, - "favicon.ico/GET":{ - "FAILED_REQUEST":1, - "MEAN_RESPONSE_TIME":1, - "MAX_RESPONSE_TIME":1, - "SUCCESS_REQUEST":0, - "TOTAL_REQUEST":1 - }, - "metrics//GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":10, - "MAX_RESPONSE_TIME":10, - "SUCCESS_REQUEST":2, - "TOTAL_REQUEST":2 - }, - "metrics/system/GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":8.942674506664073, - "MAX_RESPONSE_TIME":40, - "SUCCESS_REQUEST":2, - "TOTAL_REQUEST":2 - } + "metrics/POST": { + "FAILED_REQUEST": 1, + "MEAN_RESPONSE_TIME": 21, + "MAX_RESPONSE_TIME": 21, + "SUCCESS_REQUEST": 0, + "TOTAL_REQUEST": 1 + }, + "metrics/backend/GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 12.6852124529148, + "MAX_RESPONSE_TIME": 20, + "SUCCESS_REQUEST": 2, + "TOTAL_REQUEST": 2 + }, + "system/GET": { + "FAILED_REQUEST": 1, + "MEAN_RESPONSE_TIME": 2, + "MAX_RESPONSE_TIME": 2, + "SUCCESS_REQUEST": 0, + "TOTAL_REQUEST": 1 + }, + "metrics/gauges/GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 7, + "MAX_RESPONSE_TIME": 7, + "SUCCESS_REQUEST": 1, + "TOTAL_REQUEST": 1 + }, + "favicon.ico/GET": { + "FAILED_REQUEST": 1, + "MEAN_RESPONSE_TIME": 1, + "MAX_RESPONSE_TIME": 1, + "SUCCESS_REQUEST": 0, + "TOTAL_REQUEST": 1 + }, + "metrics//GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 10, + "MAX_RESPONSE_TIME": 10, + "SUCCESS_REQUEST": 2, + "TOTAL_REQUEST": 2 + }, + "metrics/system/GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 8.942674506664073, + "MAX_RESPONSE_TIME": 40, + "SUCCESS_REQUEST": 2, + "TOTAL_REQUEST": 2 + } } ``` - - ## 3.系统指标 系统指标主要返回机器运行指标，如内存、线程等信息。 @@ -1205,54 +1237,52 @@ GET http://localhost:8080/metrics/system ```json { - "basic": { - "mem": 1010, - "mem_total": 911, - "mem_used": 239, - "mem_free": 671, - "mem_unit": "MB", - "processors": 20, - "uptime": 137503, - "systemload_average": -1.0 - }, - "heap": { - "committed": 911, - "init": 254, - "used": 239, - "max": 3596 - }, - "nonheap": { - "committed": 98, - "init": 2, - "used": 95, - "max": 0 - }, - "thread": { - "peak": 82, - "daemon": 34, - "total_started": 108, - "count": 82 - }, - "class_loading": { - "count": 11495, - "loaded": 11495, - "unloaded": 0 - }, - "garbage_collector": { - "ps_scavenge_count": 16, - "ps_scavenge_time": 155, - "ps_marksweep_count": 3, - "ps_marksweep_time": 494, - "time_unit": "ms" - } + "basic": { + "mem": 1010, + "mem_total": 911, + "mem_used": 239, + "mem_free": 671, + "mem_unit": "MB", + "processors": 20, + "uptime": 137503, + "systemload_average": -1.0 + }, + "heap": { + "committed": 911, + "init": 254, + "used": 239, + "max": 3596 + }, + "nonheap": { + "committed": 98, + "init": 2, + "used": 95, + "max": 0 + }, + "thread": { + "peak": 82, + "daemon": 34, + "total_started": 108, + "count": 82 + }, + "class_loading": { + "count": 11495, + "loaded": 11495, + "unloaded": 0 + }, + "garbage_collector": { + "ps_scavenge_count": 16, + "ps_scavenge_time": 155, + "ps_marksweep_count": 3, + "ps_marksweep_time": 494, + "time_unit": "ms" + } } ``` - - ## 4.后端指标 -hugeGraph支持多种后端存储，后端指标包括内存、磁盘等信息。 +hugeGraph 支持多种后端存储，后端指标包括内存、磁盘等信息。 ##### Method & Url diff --git a/content/en/docs/clients/restful-api/metrics.md b/content/en/docs/clients/restful-api/metrics.md index b1ae0aa77..e87a31369 100644 --- a/content/en/docs/clients/restful-api/metrics.md +++ b/content/en/docs/clients/restful-api/metrics.md @@ -5,17 +5,17 @@ weight: 1 --- -HugeGraph provides metrics info, including basic metrics, statistical metrics, system metrics, and backend metrics. - +HugeGraph provides metrics info, including basic metrics, statistical metrics, system metrics, and +backend metrics. ## 1. Basic Metrics ### 1.1 Get All Basic Metrics - ##### Params -- type：If the passed value is JSON, it is returned in JSON format, otherwise it is returned in Promethaus format. +- type: If the passed value is JSON, it is returned in JSON format, otherwise it is returned in + Promethaus format. ##### 1.1.1 Method & Url @@ -33,409 +33,409 @@ http://localhost:8080/metrics/?type=json ```json { - "gauges":{ - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity":{ - "value":1000000 + "gauges": { + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { + "value": 1000000 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.instances":{ - "value":7 + "org.apache.hugegraph.backend.cache.Cache.instances": { + "value": 7 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity":{ - "value":10000 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { + "value": 10000 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size":{ - "value":17 + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { + "value": 17 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity":{ - "value":10000 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { + "value": 10000 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size":{ - "value":17 + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { + "value": 17 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity":{ - "value":10240 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { + "value": 10240 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity":{ - "value":10240 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { + "value": 10240 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity":{ - "value":10240 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { + "value": 10240 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity":{ - "value":10000000 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { + "value": 10000000 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire":{ - "value":600000 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { + "value": 600000 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { + "value": 0 }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size":{ - "value":0 + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { + "value": 0 }, - "org.apache.hugegraph.server.RestServer.max-write-threads":{ - "value":0 + "org.apache.hugegraph.server.RestServer.max-write-threads": { + "value": 0 }, - "org.apache.hugegraph.task.TaskManager.pending-tasks":{ - "value":0 + "org.apache.hugegraph.task.TaskManager.pending-tasks": { + "value": 0 }, - "org.apache.hugegraph.task.TaskManager.workers":{ - "value":4 + "org.apache.hugegraph.task.TaskManager.workers": { + "value": 4 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty":{ - "value":922769200 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { + "value": 922769200 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { + "value": 0 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate":{ - "value":1 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { + "value": 1 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count":{ - "value":2 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { + "value": 2 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time":{ - "value":1845538400 + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { + "value": 1845538400 }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions":{ - "value":0 + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { + "value": 0 } }, - "counters":{ - "favicon.ico/GET/FAILED_COUNTER":{ - "count":1 + "counters": { + "favicon.ico/GET/FAILED_COUNTER": { + "count": 1 }, - "favicon.ico/GET/TOTAL_COUNTER":{ - "count":1 + "favicon.ico/GET/TOTAL_COUNTER": { + "count": 1 }, - "metrics/POST/FAILED_COUNTER":{ - "count":1 + "metrics/POST/FAILED_COUNTER": { + "count": 1 }, - "metrics/POST/TOTAL_COUNTER":{ - "count":1 + "metrics/POST/TOTAL_COUNTER": { + "count": 1 }, - "metrics/backend/GET/SUCCESS_COUNTER":{ - "count":2 + "metrics/backend/GET/SUCCESS_COUNTER": { + "count": 2 }, - "metrics/backend/GET/TOTAL_COUNTER":{ - "count":2 + "metrics/backend/GET/TOTAL_COUNTER": { + "count": 2 }, - "metrics/gauges/GET/SUCCESS_COUNTER":{ - "count":1 + "metrics/gauges/GET/SUCCESS_COUNTER": { + "count": 1 }, - "metrics/gauges/GET/TOTAL_COUNTER":{ - "count":1 + "metrics/gauges/GET/TOTAL_COUNTER": { + "count": 1 }, - "metrics/system/GET/SUCCESS_COUNTER":{ - "count":2 + "metrics/system/GET/SUCCESS_COUNTER": { + "count": 2 }, - "metrics/system/GET/TOTAL_COUNTER":{ - "count":2 + "metrics/system/GET/TOTAL_COUNTER": { + "count": 2 }, - "system/GET/FAILED_COUNTER":{ - "count":1 + "system/GET/FAILED_COUNTER": { + "count": 1 }, - "system/GET/TOTAL_COUNTER":{ - "count":1 + "system/GET/TOTAL_COUNTER": { + "count": 1 } }, - "histograms":{ - "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":1, - "mean":1, - "max":1, - "stddev":0, - "p50":1, - "p75":1, - "p95":1, - "p98":1, - "p99":1, - "p999":1 - }, - "metrics/POST/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":21, - "mean":21, - "max":21, - "stddev":0, - "p50":21, - "p75":21, - "p95":21, - "p98":21, - "p99":21, - "p999":21 - }, - "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":2, - "min":6, - "mean":12.6852124529148, - "max":20, - "stddev":6.992918475157571, - "p50":6, - "p75":20, - "p95":20, - "p98":20, - "p99":20, - "p999":20 - }, - "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":7, - "mean":7, - "max":7, - "stddev":0, - "p50":7, - "p75":7, - "p95":7, - "p98":7, - "p99":7, - "p999":7 - }, - "metrics/system/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":2, - "min":0, - "mean":8.942674506664073, - "max":40, - "stddev":16.665399873223066, - "p50":0, - "p75":0, - "p95":40, - "p98":40, - "p99":40, - "p999":40 - }, - "system/GET/RESPONSE_TIME_HISTOGRAM":{ - "count":1, - "min":2, - "mean":2, - "max":2, - "stddev":0, - "p50":2, - "p75":2, - "p95":2, - "p98":2, - "p99":2, - "p999":2 + "histograms": { + "favicon.ico/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 1, + "mean": 1, + "max": 1, + "stddev": 0, + "p50": 1, + "p75": 1, + "p95": 1, + "p98": 1, + "p99": 1, + "p999": 1 + }, + "metrics/POST/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 21, + "mean": 21, + "max": 21, + "stddev": 0, + "p50": 21, + "p75": 21, + "p95": 21, + "p98": 21, + "p99": 21, + "p999": 21 + }, + "metrics/backend/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 6, + "mean": 12.6852124529148, + "max": 20, + "stddev": 6.992918475157571, + "p50": 6, + "p75": 20, + "p95": 20, + "p98": 20, + "p99": 20, + "p999": 20 + }, + "metrics/gauges/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 7, + "mean": 7, + "max": 7, + "stddev": 0, + "p50": 7, + "p75": 7, + "p95": 7, + "p98": 7, + "p99": 7, + "p999": 7 + }, + "metrics/system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 2, + "min": 0, + "mean": 8.942674506664073, + "max": 40, + "stddev": 16.665399873223066, + "p50": 0, + "p75": 0, + "p95": 40, + "p98": 40, + "p99": 40, + "p999": 40 + }, + "system/GET/RESPONSE_TIME_HISTOGRAM": { + "count": 1, + "min": 2, + "mean": 2, + "max": 2, + "stddev": 0, + "p50": 2, + "p75": 2, + "p95": 2, + "p98": 2, + "p99": 2, + "p999": 2 } }, - "meters":{ - "org.apache.hugegraph.api.API.commit-succeed":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.hugegraph.api.API.expected-error":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.hugegraph.api.API.illegal-arg":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.hugegraph.api.API.unknown-error":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.errors":{ - "count":0, - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"events/second" + "meters": { + "org.apache.hugegraph.api.API.commit-succeed": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.expected-error": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.illegal-arg": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.hugegraph.api.API.unknown-error": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.errors": { + "count": 0, + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "events/second" } }, - "timers":{ - "org.apache.hugegraph.api.auth.AccessAPI.create":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" - }, - "org.apache.hugegraph.api.auth.AccessAPI.delete":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" - }, - "org.apache.hugegraph.api.auth.AccessAPI.get":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" - }, - "org.apache.hugegraph.api.auth.AccessAPI.list":{ - "count":0, - "min":0, - "mean":0, - "max":0, - "stddev":0, - "p50":0, - "p75":0, - "p95":0, - "p98":0, - "p99":0, - "p999":0, - "duration_unit":"milliseconds", - "mean_rate":0, - "m15_rate":0, - "m5_rate":0, - "m1_rate":0, - "rate_unit":"calls/second" + "timers": { + "org.apache.hugegraph.api.auth.AccessAPI.create": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.delete": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.get": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" + }, + "org.apache.hugegraph.api.auth.AccessAPI.list": { + "count": 0, + "min": 0, + "mean": 0, + "max": 0, + "stddev": 0, + "p50": 0, + "p75": 0, + "p95": 0, + "p98": 0, + "p99": 0, + "p999": 0, + "duration_unit": "milliseconds", + "mean_rate": 0, + "m15_rate": 0, + "m5_rate": 0, + "m1_rate": 0, + "rate_unit": "calls/second" }, ... } @@ -460,7 +460,8 @@ http://localhost:8080/metrics/ ```json # HELP hugegraph_info # TYPE hugegraph_info untyped -hugegraph_info{version="0.69",} 1.0 +hugegraph_info{version="0.69", +} 1.0 # HELP org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity # TYPE org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity gauge org_apache_hugegraph_backend_cache_Cache_edge_hugegraph_capacity 1000000 @@ -531,171 +532,171 @@ http://localhost:8080/metrics/gauges ```json { - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { - "value": 1000000 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.instances": { - "value": 7 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { - "value": 10000 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { - "value": 17 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { - "value": 10000 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { - "value": 17 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { - "value": 10240 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { - "value": 10240 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { - "value": 10240 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { - "value": 10000000 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { - "value": 600000 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { - "value": 0 - }, - "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { - "value": 0 - }, - "org.apache.hugegraph.server.RestServer.max-write-threads": { - "value": 0 - }, - "org.apache.hugegraph.task.TaskManager.pending-tasks": { - "value": 0 - }, - "org.apache.hugegraph.task.TaskManager.workers": { - "value": 4 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { - "value": 9.227692E8 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { - "value": 0.0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { - "value": 0.0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { - "value": 0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { - "value": 1.0 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { - "value": 2 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { - "value": 1845538400 - }, - "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { - "value": 0 - } + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.capacity": { + "value": 1000000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.edge-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.instances": { + "value": 7 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-id-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.capacity": { + "value": 10000 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.expire": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.schema-name-hugegraph.size": { + "value": 17 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.token-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.capacity": { + "value": 10240 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.users_pwd-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.capacity": { + "value": 10000000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.expire": { + "value": 600000 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.hits": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.miss": { + "value": 0 + }, + "org.apache.hugegraph.backend.cache.Cache.vertex-hugegraph.size": { + "value": 0 + }, + "org.apache.hugegraph.server.RestServer.max-write-threads": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.pending-tasks": { + "value": 0 + }, + "org.apache.hugegraph.task.TaskManager.workers": { + "value": 4 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.average-load-penalty": { + "value": 9.227692E8 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.estimated-size": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.eviction-weight": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.hit-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-failure-rate": { + "value": 0.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.load-success-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.long-run-compilation-count": { + "value": 0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.miss-rate": { + "value": 1.0 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.request-count": { + "value": 2 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.gremlin-groovy.sessionless.class-cache.total-load-time": { + "value": 1845538400 + }, + "org.apache.tinkerpop.gremlin.server.GremlinServer.sessions": { + "value": 0 + } } ``` @@ -1033,9 +1034,7 @@ GET http://localhost:8080/metrics/timers "m1_rate": 0.0, "rate_unit": "calls/second" }, - ... - } ``` @@ -1043,8 +1042,8 @@ GET http://localhost:8080/metrics/timers ##### Params -- type：If the passed value is JSON, it is returned in JSON format, otherwise it is returned in -Promethaus format. +- type: If the passed value is JSON, it is returned in JSON format, otherwise it is returned in + Promethaus format. ##### 2.1 Method & Url @@ -1057,56 +1056,93 @@ GET http://localhost:8080/metrics/statistics ```json # HELP hugegraph_info # TYPE hugegraph_info untyped -hugegraph_info{version="0.69",} 1.0 +hugegraph_info{version="0.69", +} 1.0 # HELP metrics_POST # TYPE metrics_POST gauge metrics_POST{name=FAILED_REQUEST,} 1 metrics_POST{name=MEAN_RESPONSE_TIME,} 21.0 -metrics_POST{name=MAX_RESPONSE_TIME,} 21 -metrics_POST{name=SUCCESS_REQUEST,} 0 -metrics_POST{name=TOTAL_REQUEST,} 1 +metrics_POST{ +name=MAX_RESPONSE_TIME, +} 21 +metrics_POST{name=SUCCESS_REQUEST, +} 0 +metrics_POST{ +name=TOTAL_REQUEST, +} 1 # HELP metrics_backend_GET # TYPE metrics_backend_GET gauge -metrics_backend_GET{name=FAILED_REQUEST,} 0 -metrics_backend_GET{name=MEAN_RESPONSE_TIME,} 12.6852124529148 -metrics_backend_GET{name=MAX_RESPONSE_TIME,} 20 -metrics_backend_GET{name=SUCCESS_REQUEST,} 2 +metrics_backend_GET{name=FAILED_REQUEST, +} 0 +metrics_backend_GET{ +name=MEAN_RESPONSE_TIME, +} 12.6852124529148 +metrics_backend_GET{ +name=MAX_RESPONSE_TIME, +} 20 +metrics_backend_GET{ +name=SUCCESS_REQUEST, +} 2 metrics_backend_GET{name=TOTAL_REQUEST,} 2 # HELP system_GET # TYPE system_GET gauge system_GET{name=FAILED_REQUEST,} 1 system_GET{name=MEAN_RESPONSE_TIME,} 2.0 system_GET{name=MAX_RESPONSE_TIME,} 2 -system_GET{name=SUCCESS_REQUEST,} 0 -system_GET{name=TOTAL_REQUEST,} 1 +system_GET{ +name=SUCCESS_REQUEST, +} 0 +system_GET{name=TOTAL_REQUEST, +} 1 # HELP metrics_gauges_GET # TYPE metrics_gauges_GET gauge metrics_gauges_GET{name=FAILED_REQUEST,} 0 -metrics_gauges_GET{name=MEAN_RESPONSE_TIME,} 7.0 -metrics_gauges_GET{name=MAX_RESPONSE_TIME,} 7 -metrics_gauges_GET{name=SUCCESS_REQUEST,} 1 -metrics_gauges_GET{name=TOTAL_REQUEST,} 1 +metrics_gauges_GET{name=MEAN_RESPONSE_TIME, +} 7.0 +metrics_gauges_GET{ +name=MAX_RESPONSE_TIME, +} 7 +metrics_gauges_GET{ +name=SUCCESS_REQUEST, +} 1 +metrics_gauges_GET{ +name=TOTAL_REQUEST, +} 1 # HELP favicon.ico_GET # TYPE favicon.ico_GET gauge -favicon.ico_GET{name=FAILED_REQUEST,} 1 -favicon.ico_GET{name=MEAN_RESPONSE_TIME,} 1.0 +favicon.ico_GET{name=FAILED_REQUEST, +} 1 +favicon.ico_GET{ +name=MEAN_RESPONSE_TIME, +} 1.0 favicon.ico_GET{name=MAX_RESPONSE_TIME,} 1 favicon.ico_GET{name=SUCCESS_REQUEST,} 0 -favicon.ico_GET{name=TOTAL_REQUEST,} 1 +favicon.ico_GET{ +name=TOTAL_REQUEST, +} 1 # HELP metrics__GET # TYPE metrics__GET gauge metrics__GET{name=FAILED_REQUEST,} 0 metrics__GET{name=MEAN_RESPONSE_TIME,} 10.0 -metrics__GET{name=MAX_RESPONSE_TIME,} 10 -metrics__GET{name=SUCCESS_REQUEST,} 2 -metrics__GET{name=TOTAL_REQUEST,} 2 +metrics__GET{name=MAX_RESPONSE_TIME, +} 10 +metrics__GET{ +name=SUCCESS_REQUEST, +} 2 +metrics__GET{ +name=TOTAL_REQUEST, +} 2 # HELP metrics_system_GET # TYPE metrics_system_GET gauge metrics_system_GET{name=FAILED_REQUEST,} 0 -metrics_system_GET{name=MEAN_RESPONSE_TIME,} 8.942674506664073 -metrics_system_GET{name=MAX_RESPONSE_TIME,} 40 +metrics_system_GET{name=MEAN_RESPONSE_TIME, +} 8.942674506664073 +metrics_system_GET{ +name=MAX_RESPONSE_TIME, +} 40 metrics_system_GET{name=SUCCESS_REQUEST,} 2 -metrics_system_GET{name=TOTAL_REQUEST,} 2 +metrics_system_GET{name=TOTAL_REQUEST, +} 2 ``` @@ -1132,64 +1168,61 @@ GET http://localhost:8080/metrics/statistics?type=json ```json { - "metrics/POST":{ - "FAILED_REQUEST":1, - "MEAN_RESPONSE_TIME":21, - "MAX_RESPONSE_TIME":21, - "SUCCESS_REQUEST":0, - "TOTAL_REQUEST":1 - }, - "metrics/backend/GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":12.6852124529148, - "MAX_RESPONSE_TIME":20, - "SUCCESS_REQUEST":2, - "TOTAL_REQUEST":2 - }, - "system/GET":{ - "FAILED_REQUEST":1, - "MEAN_RESPONSE_TIME":2, - "MAX_RESPONSE_TIME":2, - "SUCCESS_REQUEST":0, - "TOTAL_REQUEST":1 - }, - "metrics/gauges/GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":7, - "MAX_RESPONSE_TIME":7, - "SUCCESS_REQUEST":1, - "TOTAL_REQUEST":1 - }, - "favicon.ico/GET":{ - "FAILED_REQUEST":1, - "MEAN_RESPONSE_TIME":1, - "MAX_RESPONSE_TIME":1, - "SUCCESS_REQUEST":0, - "TOTAL_REQUEST":1 - }, - "metrics//GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":10, - "MAX_RESPONSE_TIME":10, - "SUCCESS_REQUEST":2, - "TOTAL_REQUEST":2 - }, - "metrics/system/GET":{ - "FAILED_REQUEST":0, - "MEAN_RESPONSE_TIME":8.942674506664073, - "MAX_RESPONSE_TIME":40, - "SUCCESS_REQUEST":2, - "TOTAL_REQUEST":2 - } + "metrics/POST": { + "FAILED_REQUEST": 1, + "MEAN_RESPONSE_TIME": 21, + "MAX_RESPONSE_TIME": 21, + "SUCCESS_REQUEST": 0, + "TOTAL_REQUEST": 1 + }, + "metrics/backend/GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 12.6852124529148, + "MAX_RESPONSE_TIME": 20, + "SUCCESS_REQUEST": 2, + "TOTAL_REQUEST": 2 + }, + "system/GET": { + "FAILED_REQUEST": 1, + "MEAN_RESPONSE_TIME": 2, + "MAX_RESPONSE_TIME": 2, + "SUCCESS_REQUEST": 0, + "TOTAL_REQUEST": 1 + }, + "metrics/gauges/GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 7, + "MAX_RESPONSE_TIME": 7, + "SUCCESS_REQUEST": 1, + "TOTAL_REQUEST": 1 + }, + "favicon.ico/GET": { + "FAILED_REQUEST": 1, + "MEAN_RESPONSE_TIME": 1, + "MAX_RESPONSE_TIME": 1, + "SUCCESS_REQUEST": 0, + "TOTAL_REQUEST": 1 + }, + "metrics//GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 10, + "MAX_RESPONSE_TIME": 10, + "SUCCESS_REQUEST": 2, + "TOTAL_REQUEST": 2 + }, + "metrics/system/GET": { + "FAILED_REQUEST": 0, + "MEAN_RESPONSE_TIME": 8.942674506664073, + "MAX_RESPONSE_TIME": 40, + "SUCCESS_REQUEST": 2, + "TOTAL_REQUEST": 2 + } } ``` - - ## 3.System Metrics -System metrics mainly return the machine metrics, such as memory, threads, and other -information. +System metrics mainly return the machine metrics, such as memory, threads, and other information. ##### Method & Url @@ -1207,54 +1240,54 @@ GET http://localhost:8080/metrics/system ```json { - "basic": { - "mem": 1010, - "mem_total": 911, - "mem_used": 239, - "mem_free": 671, - "mem_unit": "MB", - "processors": 20, - "uptime": 137503, - "systemload_average": -1.0 - }, - "heap": { - "committed": 911, - "init": 254, - "used": 239, - "max": 3596 - }, - "nonheap": { - "committed": 98, - "init": 2, - "used": 95, - "max": 0 - }, - "thread": { - "peak": 82, - "daemon": 34, - "total_started": 108, - "count": 82 - }, - "class_loading": { - "count": 11495, - "loaded": 11495, - "unloaded": 0 - }, - "garbage_collector": { - "ps_scavenge_count": 16, - "ps_scavenge_time": 155, - "ps_marksweep_count": 3, - "ps_marksweep_time": 494, - "time_unit": "ms" - } + "basic": { + "mem": 1010, + "mem_total": 911, + "mem_used": 239, + "mem_free": 671, + "mem_unit": "MB", + "processors": 20, + "uptime": 137503, + "systemload_average": -1.0 + }, + "heap": { + "committed": 911, + "init": 254, + "used": 239, + "max": 3596 + }, + "nonheap": { + "committed": 98, + "init": 2, + "used": 95, + "max": 0 + }, + "thread": { + "peak": 82, + "daemon": 34, + "total_started": 108, + "count": 82 + }, + "class_loading": { + "count": 11495, + "loaded": 11495, + "unloaded": 0 + }, + "garbage_collector": { + "ps_scavenge_count": 16, + "ps_scavenge_time": 155, + "ps_marksweep_count": 3, + "ps_marksweep_time": 494, + "time_unit": "ms" + } } ``` - - ## 4.Backend Metrics -HugeGraph supports multiple backend storage, with backend metrics including memory, disk, and other information. +HugeGraph supports multiple backend storage, with backend metrics including memory, disk, and other +information. + ##### Method & Url ``` From 77b8e3144c0e4b329fd0ba9d5b0c79eee5779370 Mon Sep 17 00:00:00 2001 From: 1289220708 <1289220708@qq.com> Date: Sun, 5 Nov 2023 12:19:46 +0800 Subject: [PATCH 3/5] =?UTF-8?q?feat(website):=20add=20metric=20api=20doc?= =?UTF-8?q?=EF=BC=8Cformat=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/cn/docs/clients/restful-api/metrics.md | 5 +++-- content/en/docs/clients/restful-api/metrics.md | 8 +++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/content/cn/docs/clients/restful-api/metrics.md b/content/cn/docs/clients/restful-api/metrics.md index b523a6689..0a65e6162 100644 --- a/content/cn/docs/clients/restful-api/metrics.md +++ b/content/cn/docs/clients/restful-api/metrics.md @@ -5,7 +5,8 @@ weight: 1 --- -HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。 +HugeGraph 提供了获取监控信息的 Metrics 接口，比如各个 Gremlin 执行时间的统计、缓存的占用大小等。Metrics +接口包括如下几类：基础指标、统计指标、系统指标、后端存储指标。 ## 1. 基础指标 @@ -13,7 +14,7 @@ HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计 ##### Params -- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。 +- type：如果传值为`json`，则以 json 格式返回，否则以 Promethaus 格式返回。 ##### 1.1.1 Method & Url diff --git a/content/en/docs/clients/restful-api/metrics.md b/content/en/docs/clients/restful-api/metrics.md index e87a31369..96c0d7021 100644 --- a/content/en/docs/clients/restful-api/metrics.md +++ b/content/en/docs/clients/restful-api/metrics.md @@ -5,8 +5,10 @@ weight: 1 --- -HugeGraph provides metrics info, including basic metrics, statistical metrics, system metrics, and -backend metrics. + +HugeGraph provides a metrics interface for obtaining monitoring information, such as statistics on +each Gremlin execution time, cache size, etc. The metrics interface includes the following +categories: basic metrics, statistical metrics, system metrics, and back-end storage metrics. ## 1. Basic Metrics @@ -14,7 +16,7 @@ backend metrics. ##### Params -- type: If the passed value is JSON, it is returned in JSON format, otherwise it is returned in +- type: If the passed value is `JSON`, it is returned in JSON format, otherwise it is returned in Promethaus format. ##### 1.1.1 Method & Url From 27cf698300af73cb855ff0dbf46aba877ee67d79 Mon Sep 17 00:00:00 2001 From: 1289220708 <1289220708@qq.com> Date: Mon, 6 Nov 2023 21:23:02 +0800 Subject: [PATCH 4/5] =?UTF-8?q?feat(website):=20add=20metric=20api=20doc?= =?UTF-8?q?=EF=BC=8Cformat=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/en/docs/clients/restful-api/metrics.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/clients/restful-api/metrics.md b/content/en/docs/clients/restful-api/metrics.md index 96c0d7021..a92cb35d0 100644 --- a/content/en/docs/clients/restful-api/metrics.md +++ b/content/en/docs/clients/restful-api/metrics.md @@ -8,7 +8,7 @@ weight: 1 HugeGraph provides a metrics interface for obtaining monitoring information, such as statistics on each Gremlin execution time, cache size, etc. The metrics interface includes the following -categories: basic metrics, statistical metrics, system metrics, and back-end storage metrics. +categories: basic metrics, statistical metrics, system metrics, and backend storage metrics. ## 1. Basic Metrics @@ -16,7 +16,7 @@ categories: basic metrics, statistical metrics, system metrics, and back-end sto ##### Params -- type: If the passed value is `JSON`, it is returned in JSON format, otherwise it is returned in +- type: If the passed value is `json`, it is returned in json format, otherwise it is returned in Promethaus format. ##### 1.1.1 Method & Url From f1159fc2332525986ff3b4703b336dd217e427a1 Mon Sep 17 00:00:00 2001 From: 1289220708 <1289220708@qq.com> Date: Mon, 6 Nov 2023 23:41:34 +0800 Subject: [PATCH 5/5] =?UTF-8?q?feat(website):=20add=20metric=20api=20doc?= =?UTF-8?q?=EF=BC=8Cformat=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/cn/docs/clients/restful-api/metrics.md | 4 ++-- content/en/docs/clients/restful-api/metrics.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/cn/docs/clients/restful-api/metrics.md b/content/cn/docs/clients/restful-api/metrics.md index 0a65e6162..f4cf772b5 100644 --- a/content/cn/docs/clients/restful-api/metrics.md +++ b/content/cn/docs/clients/restful-api/metrics.md @@ -456,7 +456,7 @@ http://localhost:8080/metrics/ ##### Response Body -```json +```text # HELP hugegraph_info # TYPE hugegraph_info untyped hugegraph_info{version="0.69", @@ -1051,7 +1051,7 @@ GET http://localhost:8080/metrics/statistics ##### Response Status -```json +```text # HELP hugegraph_info # TYPE hugegraph_info untyped hugegraph_info{version="0.69", diff --git a/content/en/docs/clients/restful-api/metrics.md b/content/en/docs/clients/restful-api/metrics.md index a92cb35d0..cd67890d3 100644 --- a/content/en/docs/clients/restful-api/metrics.md +++ b/content/en/docs/clients/restful-api/metrics.md @@ -459,7 +459,7 @@ http://localhost:8080/metrics/ ##### Response Body -```json +```text # HELP hugegraph_info # TYPE hugegraph_info untyped hugegraph_info{version="0.69", @@ -1055,7 +1055,7 @@ GET http://localhost:8080/metrics/statistics ##### Response Status -```json +```text # HELP hugegraph_info # TYPE hugegraph_info untyped hugegraph_info{version="0.69",