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] Updated examples for filtered tag values #4425

Merged
merged 2 commits into from
Dec 10, 2024
Merged

[DOC] Updated examples for filtered tag values #4425

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70461eb
Updated examples for filtered tag values
knylander-grafana Dec 6, 2024
438ae1c
Update docs/sources/tempo/api_docs/_index.md
knylander-grafana Dec 9, 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
25 changes: 15 additions & 10 deletions docs/sources/tempo/api_docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,14 +365,16 @@ Parameters:
- `maxStaleValues = (integer)`
Optional. Limits the search for tags names. If the number of stale (already known) values reaches or exceeds this limit, the search stops. i.e. If Tempo processes `maxStaleValues` matches without finding a new tag name, the search is returned early.


### Search tags V2

Ingester configuration `complete_block_timeout` affects how long tags are available for search.If start or end aren't specified, it only fetches blocks that wasn't flushed to backend.
Ingester configuration `complete_block_timeout` affects how long tags are available for search.
If the start or end aren't specified, it only fetches blocks that weren't flushed to backend.

This endpoint retrieves all discovered tag names that can be used in search. The endpoint is available in the query frontend service in
a microservices deployment, or the Tempo endpoint in a monolithic mode deployment. The tags endpoint takes a scope that controls the kinds
of tags or attributes returned. If nothing is provided, the endpoint returns all resource and span tags.
This endpoint retrieves all discovered tag names that can be used in search.
The endpoint is available in the query frontend service in
a microservices deployment, or the Tempo endpoint in a monolithic mode deployment.
The tags endpoint takes a scope that controls the kinds of tags or attributes returned.
If nothing is provided, the endpoint returns all resource and span tags.

```bash
GET /api/v2/search/tags?scope=<resource|span|intrinsic>
Expand All @@ -392,7 +394,7 @@ Parameters:
- `limit = (integer)`
Optional. Sets the maximum number of tags names allowed per scope. The query stops once this limit is reached for any scope.
- `maxStaleValues = (integer)`
Optional. Limits the search for tag values. If the number of stale (already known) values reaches or exceeds this limit, the search stops.
Optional. Limits the search for tag values. The search stops if the number of stale (already known) values reaches or exceeds this limit.

#### Example

Expand Down Expand Up @@ -591,16 +593,19 @@ You can pass an optional URL query parameter, `q`, to your request.
The `q` parameter is a URL-encoded [TraceQL query]({{< relref "../traceql" >}}).
If provided, the tag values returned by the API are filtered to only return values seen on spans matching your filter parameters.

Queries can be incomplete: for example, `{ .cluster = }`. Tempo extracts only the valid matchers and build a valid query.
Queries can be incomplete: for example, `{ resource.cluster = }`.
Tempo extracts only the valid matchers and builds a valid query.
knylander-grafana marked this conversation as resolved.
Show resolved Hide resolved

Only queries with a single selector `{}` and AND `&&` operators are supported.
- Example supported: `{ .cluster = "us-east-1" && .service = "frontend" }`
- Example unsupported: `{ .cluster = "us-east-1" || .service = "frontend" } && { .cluster = "us-east-2" }`
- Example supported: `{ resource.cluster = "us-east-1" && resource.service = "frontend" }`
- Example unsupported: `{ resource.cluster = "us-east-1" || resource.service = "frontend" } && { resource.cluster = "us-east-2" }`

Unscoped attributes aren't supported for filtered tag values.

The following request returns all discovered service names on spans with `span.http.method=GET`:

```
GET /api/v2/search/tag/.service.name/values?q="{span.http.method='GET'}"
GET /api/v2/search/tag/resource.service.name/values?q="{span.http.method='GET'}"
```

If a particular service name (for example, `shopping-cart`) is only present on spans with `span.http.method=POST`, it won't be included in the list of values returned.
Expand Down
Loading