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

chore: Document approx_topk keyword. #15179

Merged
merged 4 commits into from
Dec 10, 2024
Merged

chore: Document approx_topk keyword. #15179

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
08ceaa4
(chore): Document keyword.
jeschkies Nov 28, 2024
e5062c3
Update docs/sources/query/metric_queries.md
jeschkies Dec 10, 2024
58dc4e4
Update docs/sources/query/metric_queries.md
jeschkies Dec 10, 2024
1a6e949
Merge branch 'main' into karsten/document-approx-topk
JStickler Dec 10, 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
11 changes: 11 additions & 0 deletions docs/sources/query/metric_queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,14 @@ Examples:
or
vector(0) # will return 0
```

## Probabilistic aggregation

The `topk` keyword lets you find the largest 1,000 elements in a data stream by sample size. When `topk` hits the maximum series limit, LogQL also supports using a probable approximation; `approx_topk` is a drop-in replacement when `topk` hits the maximum series limit.

```logql
approx_topk(k, <vector expression>)
```

It is only supported for instant queries and does not support grouping. It is useful when the cardinality of the inner
vector is too high, for example, when it uses an aggregation by a structured metadata label.
Loading