-
Notifications
You must be signed in to change notification settings - Fork 25.5k
Time-series docs changes #135613
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
Time-series docs changes #135613
Conversation
🔍 Preview links for changed docs |
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
# Conflicts: # x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Rate.java
Pinging @elastic/es-storage-engine (Team:StorageEngine) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the follow up @kkrik-es! Couple of nits and I noticed one important thing (using the preview = true
boolean)
...ugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Rate.java
Show resolved
Hide resolved
...ugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Rate.java
Outdated
Show resolved
Hide resolved
...ugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Rate.java
Outdated
Show resolved
Hide resolved
docs/reference/query-languages/esql/_snippets/commands/layout/stats-by.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
description = "Calculates the rate of a counter field.", | ||
description = "Calculates the per-second average rate of increase of a" | ||
+ " [counter](docs-content://manage-data/data-store/data-streams/time-series-data-stream-tsds.md#time-series-metric). " | ||
+ "Rate calculations account for changes in monotonicity, such as counter resets when a service restarts, and extrapolate " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+ "Rate calculations account for changes in monotonicity, such as counter resets when a service restarts, and extrapolate " | |
+ "Rate calculations account for counter resets such as when a service restarts, and extrapolate " |
Monotonicity has a specific meaning in the context of OTel. The rate function still only applies to monotonic counters. Non-monotonic counters aka up-down-counters are used, for example, to measure the number of currently active requests. The phrase "changes in monotonicity" may therefore be misunderstood as it's not about a metric changing from being monotonic to non-monotonic.
If you want to mention the term monotonicity, maybe rephrase as "breaks in monotonicity", rather than "changes in monotonicity".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, changes to breaks in monotonicity
that's inline with promql too.
docs/reference/query-languages/esql/_snippets/commands/layout/stats-by.md
Outdated
Show resolved
Hide resolved
…stats-by.md Co-authored-by: Felix Barnsteiner <felixbarny@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again @kkrik-es 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for adding the more extended rate description @kkrik-es!
Uh oh!
There was an error while loading. Please reload this page.