You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hugegraph.apache.org by "SunnyBoy-WYH (via GitHub)" <gi...@apache.org> on 2023/10/28 12:55:11 UTC
[PR] feat(website): add metric api doc [incubator-hugegraph-doc]
SunnyBoy-WYH opened a new pull request, #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295
we dont have metric api doc,so user even dont know it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1375276451
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
Thanks, could format the doc with IDEA plugins (refer https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940)
And sync the EN doc later (after CN doc almost done)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin merged PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "SunnyBoy-WYH (via GitHub)" <gi...@apache.org>.
SunnyBoy-WYH commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1383340932
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
i remember this:https://github.com/apache/incubator-hugegraph/pull/2286
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "SunnyBoy-WYH (via GitHub)" <gi...@apache.org>.
SunnyBoy-WYH commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1375363784
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> Thanks, could format the doc with IDEA plugins (refer [#282 (comment)](https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940))
>
> And sync the EN doc later (after CN doc almost done)
yes.
BTW, another topic, the hg code dont follow hg style totaly, so if we enable auto save, it will change some hg code unexpectedly?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1385978350
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> i remember this:[apache/incubator-hugegraph#2286](https://github.com/apache/incubator-hugegraph/pull/2286) 
Maybe no need to align like that, should keep with the auto format style as possible
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1375276451
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
Thanks, could format the doc with IDEA plugins (refer https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940)
And sync the EN doc later (after CN doc almost done)
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
Thanks, could format the doc with IDEA plugins (refer https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940)
And sync the EN doc later (after CN doc almost done)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "SunnyBoy-WYH (via GitHub)" <gi...@apache.org>.
SunnyBoy-WYH commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1375747947
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> > > Thanks, could format the doc with IDEA plugins (refer [#282 (comment)](https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940))
> > > And sync the EN doc later (after CN doc almost done)
> >
> >
> > yes.
> > BTW, another topic, the hg code dont follow hg style totaly, so if we enable auto save, it will change some hg code unexpectedly?
>
> Yes, this is a **legacy issue** from history, as plugins and style were added later and can only be adjusted locally/multiple times 🔢
Get it, but maybe some pr will be reject for changing the origin old code style (such as 'nextLine') which using hg-style.
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> > > Thanks, could format the doc with IDEA plugins (refer [#282 (comment)](https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940))
> > > And sync the EN doc later (after CN doc almost done)
> >
> >
> > yes.
> > BTW, another topic, the hg code dont follow hg style totaly, so if we enable auto save, it will change some hg code unexpectedly?
>
> Yes, this is a **legacy issue** from history, as plugins and style were added later and can only be adjusted locally/multiple times 🔢
Get it, but maybe some pr will be reject for changing the origin old code style (such as 'nextLine') which using hg-style.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1385978350
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> i remember this:[apache/incubator-hugegraph#2286](https://github.com/apache/incubator-hugegraph/pull/2286) 
Maybe no need to align like that, should keep with the auto format style as much as possible
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "javeme (via GitHub)" <gi...@apache.org>.
javeme commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1382508225
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
@@ -5,15 +5,16 @@ weight: 1
---
-HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
+HugeGraph 提供了获取监控信息的 Metrics 接口，比如各个 Gremlin 执行时间的统计、缓存的占用大小等。Metrics
+接口包括如下几类：基础指标、统计指标、系统指标、后端存储指标。
## 1. 基础指标
### 1.1 获取所有基础指标
##### Params
-- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。
+- type：如果传值为`json`，则以 json 格式返回，否则以 Promethaus 格式返回。
Review Comment:
英文版与中文版的“JSON”大小写可否保持一致？
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
@@ -5,15 +5,16 @@ weight: 1
---
-HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
+HugeGraph 提供了获取监控信息的 Metrics 接口，比如各个 Gremlin 执行时间的统计、缓存的占用大小等。Metrics
+接口包括如下几类：基础指标、统计指标、系统指标、后端存储指标。
## 1. 基础指标
### 1.1 获取所有基础指标
##### Params
-- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。
+- type：如果传值为`json`，则以 json 格式返回，否则以 Promethaus 格式返回。
Review Comment:
英文版与中文版的“JSON”大小写可否保持一致？
##########
content/en/docs/clients/restful-api/metrics.md:
##########
@@ -5,16 +5,18 @@ 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.
Review Comment:
`back-end` -- backend is ok
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "javeme (via GitHub)" <gi...@apache.org>.
javeme commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1382327281
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
@@ -0,0 +1,1344 @@
+---
+title: "Metrics API"
+linkTitle: "Metrics"
+weight: 1
+
+---
+
+HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
+
+## 1. 基础指标
+
+### 1.1 获取所有基础指标
+
+##### Params
+
+- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。
Review Comment:
以反引号括起来json？
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
@@ -0,0 +1,1344 @@
+---
+title: "Metrics API"
+linkTitle: "Metrics"
+weight: 1
+
+---
+
+HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
Review Comment:
HugeGraph 提供了获取监控信息的 Metrics 接口，比如各个 Gremlin 执行时间的统计、缓存的占用大小等。Metrics 接口包括如下几类：基础指标、统计指标、系统指标、后端存储指标。
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
@@ -0,0 +1,1344 @@
+---
+title: "Metrics API"
+linkTitle: "Metrics"
+weight: 1
+
+---
+
+HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
Review Comment:
HugeGraph 提供了获取监控信息的 Metrics 接口，比如各个 Gremlin 执行时间的统计、缓存的占用大小等。Metrics 接口包括如下几类：基础指标、统计指标、系统指标、后端存储指标。
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
@@ -0,0 +1,1344 @@
+---
+title: "Metrics API"
+linkTitle: "Metrics"
+weight: 1
+
+---
+
+HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
+
+## 1. 基础指标
+
+### 1.1 获取所有基础指标
+
+##### Params
+
+- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。
Review Comment:
以反引号括起来json？
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1375618811
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> > Thanks, could format the doc with IDEA plugins (refer [#282 (comment)](https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940))
> > And sync the EN doc later (after CN doc almost done)
>
> yes.
>
> BTW, another topic, the hg code dont follow hg style totaly, so if we enable auto save, it will change some hg code unexpectedly?
Yes, this is a **legacy issue** from history, as plugins and style were added later and can only be adjusted locally/multiple times
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> > Thanks, could format the doc with IDEA plugins (refer [#282 (comment)](https://github.com/apache/incubator-hugegraph-doc/pull/282#issuecomment-1719156940))
> > And sync the EN doc later (after CN doc almost done)
>
> yes.
>
> BTW, another topic, the hg code dont follow hg style totaly, so if we enable auto save, it will change some hg code unexpectedly?
Yes, this is a **legacy issue** from history, as plugins and style were added later and can only be adjusted locally/multiple times 🔢
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1383481875
##########
content/en/docs/clients/restful-api/metrics.md:
##########
@@ -0,0 +1,1350 @@
+---
+title: "Metrics API"
+linkTitle: "Metrics"
+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 backend storage 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
Review Comment:
seems wrong comment `#` with `json`? use other language format?
##########
content/en/docs/clients/restful-api/metrics.md:
##########
@@ -0,0 +1,1350 @@
+---
+title: "Metrics API"
+linkTitle: "Metrics"
+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 backend storage 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",
Review Comment:
same
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] feat(website): add metric api doc [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #295:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/295#discussion_r1381316819
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> Get it, but maybe some pr will be reject for changing the origin old code style (such as 'nextLine') which using hg-style.
could u show some example? We could choose the proper way
##########
content/cn/docs/clients/restful-api/metrics.md:
##########
Review Comment:
> Get it, but maybe some pr will be reject for changing the origin old code style (such as 'nextLine') which using hg-style.
could u show some example? We could choose the proper one
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org