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.

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

Improve metrics setup and docs #659

Merged
merged 3 commits into from
Dec 8, 2020

Conversation

britto
Copy link
Contributor

@britto britto commented Oct 7, 2020

While building a custom metrics module for hackney I noticed a few inconsistencies in how some metrics are set up and documented. This PR addresses three of them. I've split them into separate commits to make it easier to review and eventually drop whatever may be irrelevant.

  1. Fix the queue_count metric documentation and setup. It was being initialized as queue_counter in metrics:new;
  2. Update pool metric docs to match their names. They are currently prefixed with hackney_pool, but show up prefixed with hackney in the docs;
  3. Add documentation for 2 host-based pool metrics: new_connection and reuse_connection.

Update: Sorry, just noticed 1. is the same change proposed at #583, 2. and 3. are still valid though.

It was being initialized and deleted as `queue_counter` instead.
Their declared prefix is `hackney_pool`, not `hackney`.
* hackney_pool.HOST.new_connection
* hackney_pool.HOST.reuse_connection
@benoitc benoitc merged commit a5be812 into benoitc:master Dec 8, 2020
@benoitc
Copy link
Owner

benoitc commented Dec 8, 2020

thanks!

@britto britto deleted the improve-metrics-setup-and-docs branch December 10, 2020 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants