Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

docs: update the metrics as a table #963

Merged
merged 1 commit into from
Sep 26, 2019

Conversation

SataQiu
Copy link
Member

@SataQiu SataQiu commented Sep 25, 2019

Signed-off-by: SataQiu [email protected]

Ⅰ. Describe what this PR did

docs: update the metrics as a table

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)? (你真的觉得不需要加测试吗?)

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

@codecov-io
Copy link

codecov-io commented Sep 25, 2019

Codecov Report

Merging #963 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #963   +/-   ##
=======================================
  Coverage   46.48%   46.48%           
=======================================
  Files         116      116           
  Lines        6908     6908           
=======================================
  Hits         3211     3211           
  Misses       3440     3440           
  Partials      257      257
Impacted Files Coverage Δ
supernode/server/piece_error_bridge.go 0% <0%> (ø) ⬆️
dfdaemon/config/config.go 100% <0%> (ø) ⬆️
...get/core/downloader/p2p_downloader/power_client.go 52.17% <0%> (ø) ⬆️
hack/boilerplate/check-boilerplate.go 36.58% <0%> (ø) ⬆️
supernode/daemon/mgr/peer/manager.go 78.65% <0%> (ø) ⬆️
client/request.go 36.84% <0%> (ø) ⬆️
dfget/core/downloader/p2p_downloader/piece.go 24.32% <0%> (ø) ⬆️
dfget/core/uploader/peer_server.go 86.39% <0%> (ø) ⬆️
client/httputils.go 40.42% <0%> (ø) ⬆️
supernode/server/metrics.go 70.14% <0%> (ø) ⬆️
... and 14 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 71d3b08...0b9b2ac. Read the comment docs.

@starnop
Copy link
Contributor

starnop commented Sep 25, 2019

Could you please add a column in the table and stuff metrics type into it?

@SataQiu SataQiu force-pushed the improve-docs-20190925 branch from 8e23995 to 17f2aa8 Compare September 25, 2019 06:30
@SataQiu
Copy link
Member Author

SataQiu commented Sep 25, 2019

Could you please add a column in the table and stuff metrics type into it?

Sure! Done.

- dragonfly_supernode_pieces_downloaded_size_bytes_total{} - total size of pieces downloaded from supernode in bytes. counter type.
- dragonfly_supernode_gc_peers_total{} - total number of peers that have been garbage collected. counter type.
- dragonfly_supernode_gc_tasks_total{} - total number of tasks that have been garbage collected. counter type.
Name | Type | Description
Copy link
Contributor

Choose a reason for hiding this comment

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

So embarrassed. 😢 And could you please add a column in the table and stuff labels into it?

@starnop starnop requested a review from yeya24 September 25, 2019 11:46
- dragonfly_supernode_gc_tasks_total{} - total number of tasks that have been garbage collected. counter type.
Name | Type | Description
:----------------------------------------------------------------------- | :-------- | :----------
dragonfly_supernode_build_info{version, revision, goversion, arch, os} | gauge | build and version information of supernode.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I hope we can separate the metric name and its labels. So please add another column called labels

Name | Type | Description
:----------------------------------------------------------------------- | :-------- | :----------
dragonfly_supernode_build_info{version, revision, goversion, arch, os} | gauge | build and version information of supernode.
dragonfly_supernode_http_requests_total{code, handler, method} | counter | total number of http requests.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please capitalize all these metrics description sentences.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@SataQiu SataQiu force-pushed the improve-docs-20190925 branch from 0b49dca to 0b9b2ac Compare September 26, 2019 02:58
Copy link
Collaborator

@yeya24 yeya24 left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks for your great work!

@starnop
Copy link
Contributor

starnop commented Sep 26, 2019

LGTM.

Good job. THX.

@starnop starnop merged commit 37d635e into dragonflyoss:master Sep 26, 2019
starnop added a commit to starnop/Dragonfly that referenced this pull request Nov 27, 2019
inoc603 pushed a commit to inoc603/Dragonfly that referenced this pull request Dec 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants