ref(metrics): Document metrics and remove macro_use #1045
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This improves some documentation by explaining the different metric types and the difference between record and observe. It's also a bit opinionated about metric types. It also restructures the code a bit to make use of the 2018-edition macro scoping rules, so macros are not magically available and use can import them from the metrics module, which gives much better context.
Arqu
approved these changes
May 24, 2023
| //! - To record a **gauge** ( or a **counter**), use the [`record`] macro with a value. | ||
| //! Don't use gauges though. | ||
| //! - To increment a **counter** by 1, use the [`inc`] macro. | ||
| //! - For **histograms** (or **summaries**, but don't use those either) use the [`observe`] |
There was a problem hiding this comment.
Well there are use cases for histograms, and summaries are not properly supported yet.
There was a problem hiding this comment.
That's meant to say "don't use summaries", which again is me being opinionated. If summaries are not supported I'm happy to just erase their existence from here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This improves some documentation by explaining the different metric
types and the difference between record and observe. It's also a bit
opinionated about metric types.
It also restructures the code a bit to make use of the 2018-edition
macro scoping rules, so macros are not magically available and use can
import them from the metrics module, which gives much better context.