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] Add missing doc for metrics #3726

Merged

Conversation

knylander-grafana
Copy link
Contributor

@knylander-grafana knylander-grafana commented May 28, 2024

What this PR does:
Adds missing doc for quantile_over_time, histrogram, and rate.

Related: #3605, #3633, #3644

Questions for reviewers:

  • Are the listed functions correct? There are only three. Should there be additional ones?
  • Please add any additional content or examples. It's rather sparse.

Which issue(s) this PR fixes:
Fixes #

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label May 28, 2024
@knylander-grafana knylander-grafana self-assigned this May 28, 2024
docs/sources/tempo/traceql/metrics-queries.md Outdated Show resolved Hide resolved
These functions can be added as an operator at the end of any TraceQL query.

`rate`
: Provides the percentage of
Copy link
Contributor

Choose a reason for hiding this comment

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

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What does rate actually do? I was trying to figure out the best way to define it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Rate is like count_over_time, but normalized to spans per second. They are based on the granularity of the step parameter in the request. If your step is 1 minute, then rate = count_over_time / 60 (there are 60 seconds in a minute).

docs/sources/tempo/traceql/metrics-queries.md Outdated Show resolved Hide resolved
Copy link
Contributor

This PR must be merged before a backport PR will be created.

@knylander-grafana knylander-grafana merged commit 56a0b8c into grafana:main May 30, 2024
16 checks passed
@knylander-grafana knylander-grafana deleted the add-missing-metrics-doc branch May 30, 2024 21:49
github-actions bot pushed a commit that referenced this pull request May 30, 2024
* Add missing doc for metrics

* Update docs/sources/tempo/operations/traceql-metrics.md

* Apply suggestions from code review

Co-authored-by: Martin Disibio <[email protected]>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Martin Disibio <[email protected]>

---------

Co-authored-by: Martin Disibio <[email protected]>
(cherry picked from commit 56a0b8c)
knylander-grafana added a commit that referenced this pull request May 31, 2024
* [DOC] Add missing doc for metrics (#3726)

* Add missing doc for metrics

* Update docs/sources/tempo/operations/traceql-metrics.md

* Apply suggestions from code review

Co-authored-by: Martin Disibio <[email protected]>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Martin Disibio <[email protected]>

---------

Co-authored-by: Martin Disibio <[email protected]>
(cherry picked from commit 56a0b8c)

* Update docs/sources/tempo/operations/traceql-metrics.md

---------

Co-authored-by: Kim Nylander <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.5 type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants