Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(website): add metric api doc #295

Merged
merged 5 commits into from
Nov 14, 2023
+2,699 −0
Merged

feat(website): add metric api doc #295

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a35bbeb
feat(website): add metric api doc
SunnyBoy-WYH Oct 28, 2023
dfca306
feat(website): add metric api doc，format doc
SunnyBoy-WYH Oct 29, 2023
77b8e31
feat(website): add metric api doc，format doc
SunnyBoy-WYH Nov 5, 2023
27cf698
feat(website): add metric api doc，format doc
SunnyBoy-WYH Nov 6, 2023
f1159fc
feat(website): add metric api doc，format doc
SunnyBoy-WYH Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions content/cn/docs/clients/restful-api/metrics.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, could format the doc with IDEA plugins (refer #282 (comment))

And sync the EN doc later (after CN doc almost done)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, could format the doc with IDEA plugins (refer #282 (comment))

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?

Copy link
Member

@imbajin imbajin Oct 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, could format the doc with IDEA plugins (refer #282 (comment))
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 🔢

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, could format the doc with IDEA plugins (refer #282 (comment))
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.

Copy link
Member

@imbajin imbajin Nov 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i remember this:apache/incubator-hugegraph#2286
image

Copy link
Member

@imbajin imbajin Nov 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i remember this:apache/incubator-hugegraph#2286 image

Maybe no need to align like that, should keep with the auto format style as much as possible

Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ weight: 1

---

HugeGraph 提供关于 Metrics 的信息披露，包括：基础指标、统计指标、系统指标、后端指标。
HugeGraph 提供了获取监控信息的 Metrics 接口，比如各个 Gremlin 执行时间的统计、缓存的占用大小等。Metrics
接口包括如下几类：基础指标、统计指标、系统指标、后端存储指标。

## 1. 基础指标

### 1.1 获取所有基础指标

##### Params

- type：如果传值为 json，则以 json 格式返回，否则以 Promethaus 格式返回。
- type：如果传值为`json`，则以 json 格式返回，否则以 Promethaus 格式返回。
SunnyBoy-WYH marked this conversation as resolved.
Show resolved Hide resolved

##### 1.1.1 Method & Url

Expand Down
8 changes: 5 additions & 3 deletions content/en/docs/clients/restful-api/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
SunnyBoy-WYH marked this conversation as resolved.
Show resolved Hide resolved

## 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
- 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
Expand Down