Skip to content

[release-v2.7] [DOC] Update count_over_time docs #5055

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.

Sign up for GitHub

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

Merged
knylander-grafana merged 1 commit into from
Apr 24, 2025
Merged

[release-v2.7] [DOC] Update count_over_time docs #5055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/sources/tempo/traceql/metrics-queries/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ TraceQL metrics can help you answer these questions by parsing your traces in ag

TraceQL metrics are powered by the [TraceQL metrics API](https://grafana.com/docs/tempo/<TEMPO_VERSION>/api_docs/#traceql-metrics).

![Metrics visualization in Grafana](/media/docs/tempo/metrics-explore-sample-2.4.png)
![Metrics visualization in Grafana](/media/docs/tempo/metrics-explore-sapmle-v2.7.png)

## RED metrics, TraceQL, and PromQL

Expand Down
21 changes: 19 additions & 2 deletions docs/sources/tempo/traceql/metrics-queries/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,25 @@ spans than `/api/happy`, for example.
## The `count_over_time` function

The `count_over_time()` function counts the number of matching spans per time interval.
The time interval that the count will be computed over is set by the `step` parameter.
For more information, refer to the [`step` API parameter](https://grafana.com/docs/tempo/<TEMPO_VERSION>/api_docs/#traceql-metrics).
The time interval that the count is computed over is set by the `step` parameter.

### The `step` parameter

Ths `step` parameter defines the granularity of the returned time-series.
For example, `step=15s` returns a data point every 15s within the time range.
By default, `step` automatically chooses a dynamic value based on the query start time and end time.

Any value used for `step` needs to include a duration value, such as `30s` for `s`econds or `1m` for `m`inutes.

You can configure this parameter using Grafana Explore or using the Tempo API.
Refer to the [`step` API parameter](https://grafana.com/docs/tempo/<TEMPO_VERSION>/api_docs/#traceql-metrics) for information about using the API.

To check or change the `step` value using Grafana Explore:
1. Select your Tempo data source.
1. Select either the **Search** or **TraceQL** query type tab.
1. Expand the **Metrics options** to view the **Step** value.

![The Step value in the Metrics options in Grafana Explore](/media/docs/tempo/tempo-ds-query-metrics-options-step.png)

### Example

Expand Down