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

doc: clarify rate values are averaged #14045

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

asymmetric
Copy link

@asymmetric asymmetric commented May 3, 2024

In the previous formulation, it wasn't clear to me what [5m] was doing, now it should be more clear that it's the window used to calculate the average.

Signed-off-by: asymmetric <101816+asymmetric@users.noreply.github.com>
@bboreham
Copy link
Member

bboreham commented May 4, 2024

You don't think "the per-second average rate of increase", a few lines up, already covered it?

@asymmetric
Copy link
Author

For me it wasn't clear enough no, although I guess it could be for others. But if this doesn't decrease clarity for anyone, and only increases it for some, I think it makes sense to merge.

@@ -532,7 +532,7 @@ resets due to target restarts) are automatically adjusted for. Also, the
calculation extrapolates to the ends of the time range, allowing for missed
scrapes or imperfect alignment of scrape cycles with the range's time period.

The following example expression returns the per-second rate of HTTP requests as measured
The following example expression returns the per-second rate of HTTP requests averaged
Copy link
Member

Choose a reason for hiding this comment

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

Maybe let's stay as consistent as possible and use the same wording as above, so no misunderstanding is possible that we are talking about the same thing as in the previous paragraph?

Suggested change
The following example expression returns the per-second rate of HTTP requests averaged
The following example expression returns the per-second average rate of HTTP requests

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

3 participants