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.

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

[DOC] Add deprecation for metrics summary #4193

Merged
merged 4 commits into from
Oct 22, 2024
Merged

[DOC] Add deprecation for metrics summary #4193

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f33b927
Add deprecation for metrics summary
knylander-grafana Oct 15, 2024
227b066
Update docs/sources/tempo/api_docs/metrics-summary.md
knylander-grafana Oct 15, 2024
2d898bf
Update docs/sources/tempo/api_docs/metrics-summary.md
knylander-grafana Oct 16, 2024
51003c7
Apply suggestions from code review
knylander-grafana Oct 16, 2024
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
10 changes: 7 additions & 3 deletions docs/sources/tempo/api_docs/metrics-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,18 @@ weight: 600
# Metrics summary API

{{< admonition type="warning" >}}
The Metrics summary API is an [experimental feature](/docs/release-life-cycle) that is disabled by default. To enable it, adjust your configuration as suggested below.
The metrics summary API is deprecated as of Tempo 2.7. Features powered by the metrics summary API, like the Aggregate by table, are also deprecated in Grafana Cloud and Grafana 11.3 and later.
It will be removed in a future release.
{{% /admonition %}}

This document explains how to use the metrics summary API in Tempo.
This API returns RED metrics (span count, erroring span count, and latency information) for `kind=server` spans sent to Tempo in the last hour, grouped by a user-specified attribute.

{{< youtube id="g97CjKOZqT4" >}}

## Configuration
## Activate metrics summary

To enable the experimental metrics summary API, you must turn on the local blocks processor in the metrics generator.
To enable the (deprecated) metrics summary API, you must turn on the local blocks processor in the metrics generator.
Be aware that the generator uses considerably more resources, including disk space, if it's enabled:

```yaml
Expand All @@ -30,6 +31,9 @@ overrides:
processors: [..., 'local-blocks']
```
In Grafana and Grafana Cloud, the Metrics summary API is disabled by default.
To enable it in Grafana Cloud, contact Grafana Support.
## Request
To make a request to this API, use the following endpoint on the query-frontend:
Expand Down