Skip to content

Conversation

kkrik-es
Copy link
Contributor

@kkrik-es kkrik-es commented Sep 29, 2025

  • Mark time series aggs as preview
  • Expand rate description
  • Fix preview tags for functions
  • Add note in stats for time series aggs

@kkrik-es kkrik-es self-assigned this Sep 29, 2025
@kkrik-es kkrik-es added >non-issue Team:StorageEngine :StorageEngine/ES|QL Timeseries / metrics / logsdb capabilities in ES|QL labels Sep 29, 2025
Copy link
Contributor

github-actions bot commented Sep 29, 2025

🔍 Preview links for changed docs

Copy link
Contributor

ℹ️ 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 overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

@kkrik-es kkrik-es marked this pull request as ready for review September 29, 2025 13:48
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-storage-engine (Team:StorageEngine)

@elastic elastic deleted a comment Sep 29, 2025
@kkrik-es kkrik-es changed the title Extend rate documentation Time-series docs changes Sep 29, 2025
Copy link
Contributor

@leemthompo leemthompo left a 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)

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 "
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
+ "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".

Copy link
Contributor Author

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.

kkrik-es and others added 2 commits September 30, 2025 12:06
…stats-by.md

Co-authored-by: Felix Barnsteiner <felixbarny@users.noreply.github.com>
Copy link
Contributor

@leemthompo leemthompo left a 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 👍

Copy link

@yannis-roussos yannis-roussos 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 adding the more extended rate description @kkrik-es!

@kkrik-es kkrik-es enabled auto-merge (squash) September 30, 2025 14:04
@kkrik-es kkrik-es disabled auto-merge September 30, 2025 15:32
@kkrik-es kkrik-es merged commit f858d3e into elastic:main Sep 30, 2025
32 of 35 checks passed
@kkrik-es kkrik-es deleted the tsdb/rate-doc branch October 1, 2025 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>non-issue :StorageEngine/ES|QL Timeseries / metrics / logsdb capabilities in ES|QL Team:StorageEngine v9.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants