Frontend Refactor: Streaming tags #3460

joe-elliott · 2024-03-04T21:37:03Z

What this PR does:
Moves all tags endpoints over to the new frontend async pipeline. Additionally adds:

Streaming support to all tags endpoints
Cache support for tags
- See notes. I'm wondering if caching tag values is worth it.
Integration tests for streaming tags endpoints
CLI support for tags endpoints

Which issue(s) this PR fixes:
Work toward #3400

Checklist

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

Signed-off-by: Joe Elliott <number101010@gmail.com>

CHANGELOG.md

docs/sources/tempo/operations/tempo_cli.md

cmd/tempo-cli/cmd-query-search-tag-values.go

mapno · 2024-03-07T14:18:29Z

integration/e2e/config-all-in-one-local.yaml

@@ -1,4 +1,5 @@
 target: all
+stream_over_http_enabled: true


Streaming in the tests is done via gPRC no? Why is this needed?

streaming in the all in one is done using the shared port:

https://github.com/grafana/tempo/pull/3460/files#diff-0a565c64b055da77723873043e49f4e2b89ed84165f78320ee9e4508ee376857R323

mapno · 2024-03-07T15:57:40Z

modules/frontend/tag_handlers_test.go

+	go func() {
+		time.Sleep(50 * time.Millisecond)
+		cancel()
+	}()


Why not cancel synchronously? This is adding instability to the tests.

these tests are comprehensive, but poorly organized. as i move more endpoints to the new streaming pipeline i want to clean them up but they are becoming quite unruly.

in this case:

we put the http request in the http pipeline here: https://github.com/grafana/tempo/pull/3460/files#diff-512f96e1e3fb3f728660709269d6e2089a469dd022967684aaea6d035a2c4203R117

the go func you've highlighted cancels the context 50ms later

50ms beats the timeout here: https://github.com/grafana/tempo/blob/main/modules/frontend/search_handlers_test.go#L66

so we expect a context canceled error (which we get)

we need the async go func so we cancel the context while the http request is in flight.

modules/frontend/cache_keys.go

Co-authored-by: Mario <mariorvinas@gmail.com>

Signed-off-by: Joe Elliott <number101010@gmail.com>

mapno

LGTM

docs/sources/tempo/api_docs/_index.md

knylander-grafana · 2024-03-19T19:51:06Z

docs/sources/tempo/operations/tempo_cli.md

+Arguments:
+- `host-port` A host/port combination for Tempo. The scheme will be inferred based on the options provided.
+- `tag` The fully qualified traceql tag to search for. e.g. `resource.service.name`
+- `start` Start of the time range to search: (YYYY-MM-DDThh:mm:ss)
+- `end` End of the time range to search: (YYYY-MM-DDThh:mm:ss)
+
+Options:
+- `--org-id <value>`      Organization ID (for use in multi-tenant setup).
+- `--use-grpc`            Use GRPC streaming
+- `--path-prefix <value>` String to prefix search paths with


This is the kind of thing you might consider using a definition list, which is supported by Hugo. That the top item (the term) is bold, and the definition appears underneath.

Suggested change

Arguments:

- `host-port` A host/port combination for Tempo. The scheme will be inferred based on the options provided.

- `tag` The fully qualified traceql tag to search for. e.g. `resource.service.name`

- `start` Start of the time range to search: (YYYY-MM-DDThh:mm:ss)

- `end` End of the time range to search: (YYYY-MM-DDThh:mm:ss)

Options:

- `--org-id <value>` Organization ID (for use in multi-tenant setup).

- `--use-grpc` Use GRPC streaming

- `--path-prefix <value>` String to prefix search paths with

Arguments:

`host-port`

: A host/port combination for Tempo. The scheme will be inferred based on the options provided.

`tag`

: The fully qualified traceql tag to search for; for example: `resource.service.name`

`start`

: Start of the time range to search: (`YYYY-MM-DDThh:mm:ss`)

`end`

: End of the time range to search: (`YYYY-MM-DDThh:mm:ss`)

Options:

`--org-id <value>`

: Organization ID (for use in multi-tenant setup).

`--use-grpc`

: Use GRPC streaming

`--path-prefix <value>`

: String to prefix search paths with

I like this idea but there are a ton of commands in this file and if we go to definition lists then we should do all at once.

knylander-grafana

Thank you for updating the docs! I had a minor formatting suggestion.

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* cancel context Signed-off-by: Joe Elliott <number101010@gmail.com> * update dskit Signed-off-by: Joe Elliott <number101010@gmail.com> * focused timeouts Signed-off-by: Joe Elliott <number101010@gmail.com> * docs Signed-off-by: Joe Elliott <number101010@gmail.com> * lint N docs Signed-off-by: Joe Elliott <number101010@gmail.com> * more lint Signed-off-by: Joe Elliott <number101010@gmail.com> * make update-mod Signed-off-by: Joe Elliott <number101010@gmail.com> --------- Signed-off-by: Joe Elliott <number101010@gmail.com>

Bumps [anchore/sbom-action](https://github.com/anchore/sbom-action) from 0.15.8 to 0.15.9. - [Release notes](https://github.com/anchore/sbom-action/releases) - [Commits](anchore/sbom-action@v0.15.8...v0.15.9) --- updated-dependencies: - dependency-name: anchore/sbom-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* doc: remove reference to previously purged script * doc: correct label for docs updates

…ation check (grafana#3484) * Use new per-tenant max_metrics_duration, and fix duration timestamp handling * Update docs and defaults

* Handle prefixes when listing blocks from S3 fixes grafana#3465 * Handle prefixes when listing blocks from GCS * Add test for prefixes when listing blocks from Azure * Update unit tests to check for actual block IDs instead of just length of the slices Cleanup unit tests * Further refine S3/GCS backend for ListBlocks Brings logic more in line with Azure object parsing. Also has the benefit of handling prefixes without a trailing slash. * Update poller integration test to exercise prefixes * Update e2e test to exercise prefixes * Fix format check error * Fix failing e2e tests * Remove unnecessary prefix permutations from e2e test * Remove unnecessary test config file copy * Ignore lint --------- Co-authored-by: Zach Leslie <zach.leslie@grafana.com>

Updates the doc-validator to the latest version. Note that this changes the reference format to use the full URL (https://....) instead of /docs/blah

* [DOC] Document Tempo Operator Monolithic mode Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> * clarify supported storages Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> * fix case of title Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> * Apply suggestions from code review * Apply suggestions from code review --------- Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

…ators (grafana#3473) * [docs] document Grafana data source setup using Grafana and Tempo operators * move the Grafana data source setup page to the operator folder (this page is only relevant for the operator) * document Grafana data source setup using Grafana and Tempo operators Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> * Apply suggestions from code review --------- Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com> Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>

…na#3455) * Bump github.com/prometheus/client_golang from 1.18.0 to 1.19.0 Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.18.0 to 1.19.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.18.0...v1.19.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Update serverless gomod --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: grafanabot <bot@grafana.com>

…#3458) * Add support for dashes, quotes and spaces in attribute names * chlog

* Step align query_range time range * Time range error: improve message and fix format for prom format. * oops remove printlns * lint * changelog

Signed-off-by: Joe Elliott <number101010@gmail.com>

joe-elliott added 24 commits March 4, 2024 08:29

log request

be057fb

Signed-off-by: Joe Elliott <number101010@gmail.com>

move stuff a bit

9af6330

Signed-off-by: Joe Elliott <number101010@gmail.com>

oh my. e2e tests pass

0c7e67b

Signed-off-by: Joe Elliott <number101010@gmail.com>

add handlers

349727c

Signed-off-by: Joe Elliott <number101010@gmail.com>

streaming tags

5c4c0dd

Signed-off-by: Joe Elliott <number101010@gmail.com>

add cli support

14f6c70

Signed-off-by: Joe Elliott <number101010@gmail.com>

improve logging

e6f3d29

Signed-off-by: Joe Elliott <number101010@gmail.com>

fix

ff08ac8

Signed-off-by: Joe Elliott <number101010@gmail.com>

docs

1d37935

Signed-off-by: Joe Elliott <number101010@gmail.com>

pipe overrides

52f9d95

Signed-off-by: Joe Elliott <number101010@gmail.com>

cleanup

91a0dbb

Signed-off-by: Joe Elliott <number101010@gmail.com>

cleanup

55ec531

Signed-off-by: Joe Elliott <number101010@gmail.com>

support limits

71e0358

Signed-off-by: Joe Elliott <number101010@gmail.com>

docs

e3155c5

Signed-off-by: Joe Elliott <number101010@gmail.com>

e2e tests and caching

792e409

Signed-off-by: Joe Elliott <number101010@gmail.com>

key prefixes

2e96b6c

Signed-off-by: Joe Elliott <number101010@gmail.com>

cache keys

141383a

Signed-off-by: Joe Elliott <number101010@gmail.com>

Fixed distinct collection in combiners

b28e175

Signed-off-by: Joe Elliott <number101010@gmail.com>

fixed combiner bugs and revived tests

c9dddb5

Signed-off-by: Joe Elliott <number101010@gmail.com>

restored all tests

2cc2756

Signed-off-by: Joe Elliott <number101010@gmail.com>

lint

d0d7926

Signed-off-by: Joe Elliott <number101010@gmail.com>

made search handler utilities generic

800523e

Signed-off-by: Joe Elliott <number101010@gmail.com>

Added handler tests for tags

4794ff7

Signed-off-by: Joe Elliott <number101010@gmail.com>

add diff support

63241c6

Signed-off-by: Joe Elliott <number101010@gmail.com>

joe-elliott marked this pull request as ready for review March 5, 2024 17:36

joe-elliott requested review from knylander-grafana, annanay25, mdisibio, mapno and kvrhdn as code owners March 5, 2024 17:36

mapno reviewed Mar 7, 2024

View reviewed changes

joe-elliott and others added 2 commits March 7, 2024 16:12

Update docs/sources/tempo/operations/tempo_cli.md

313a4f3

Co-authored-by: Mario <mariorvinas@gmail.com>

review

2018b7c

Signed-off-by: Joe Elliott <number101010@gmail.com>

mapno approved these changes Mar 15, 2024

View reviewed changes

joe-elliott mentioned this pull request Mar 15, 2024

Tempo Query Frontend Refactor #3413

Closed

9 tasks

knylander-grafana reviewed Mar 19, 2024

View reviewed changes

docs/sources/tempo/api_docs/_index.md Outdated Show resolved Hide resolved

knylander-grafana reviewed Mar 19, 2024

View reviewed changes

joe-elliott and others added 19 commits March 19, 2024 16:04

Update docs/sources/tempo/api_docs/_index.md

27e1a62

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

Doc update (grafana#3482)

61bd874

* doc: remove reference to previously purged script * doc: correct label for docs updates

[TraceQL Metrics] Use new per-tenant max_metrics_duration and fix dur…

f9b3198

…ation check (grafana#3484) * Use new per-tenant max_metrics_duration, and fix duration timestamp handling * Update docs and defaults

Update doc-validator.yml (grafana#3483)

277f6ba

Updates the doc-validator to the latest version. Note that this changes the reference format to use the full URL (https://....) instead of /docs/blah

[DOC] fix typo in setup/operator/monolithic.md (grafana#3496)

d0cb971

Signed-off-by: Andreas Gerstmayr <agerstmayr@redhat.com>

Add support for dashes, quotes and spaces in attribute names (grafana…

c45de36

…#3458) * Add support for dashes, quotes and spaces in attribute names * chlog

[TraceQL Metrics] Step align query_range time range (grafana#3490)

ae9f03b

* Step align query_range time range * Time range error: improve message and fix format for prom format. * oops remove printlns * lint * changelog

2.4.1 changelog (grafana#3503)

b539073

Signed-off-by: Joe Elliott <number101010@gmail.com>

[DOC] Add 2.4.1 release notes (grafana#3504)

73a2f62

Merge branch 'main' into streaming-tags

2236aad

fix tests due to interface changing

828b102

Signed-off-by: Joe Elliott <number101010@gmail.com>

Merge branch 'main' into streaming-tags

c1e7cee

Pass context

9df0271

Signed-off-by: Joe Elliott <number101010@gmail.com>

joe-elliott merged commit c61bd1b into grafana:main Mar 20, 2024
15 checks passed

09jvilla mentioned this pull request Mar 26, 2024

Use the start and end parameters of the search tags and search tag values APIs grafana/grafana#81916

Open

joe-elliott mentioned this pull request Apr 23, 2024

Pagination for tag search endpoint #3599

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Frontend Refactor: Streaming tags #3460

Frontend Refactor: Streaming tags #3460

joe-elliott commented Mar 4, 2024

mapno Mar 7, 2024

joe-elliott Mar 7, 2024

mapno Mar 7, 2024

joe-elliott Mar 7, 2024

mapno left a comment

knylander-grafana Mar 19, 2024

joe-elliott Mar 19, 2024

knylander-grafana left a comment

Frontend Refactor: Streaming tags #3460

Frontend Refactor: Streaming tags #3460

Conversation

joe-elliott commented Mar 4, 2024

mapno Mar 7, 2024

Choose a reason for hiding this comment

joe-elliott Mar 7, 2024

Choose a reason for hiding this comment

mapno Mar 7, 2024

Choose a reason for hiding this comment

joe-elliott Mar 7, 2024

Choose a reason for hiding this comment

mapno left a comment

Choose a reason for hiding this comment

knylander-grafana Mar 19, 2024

Choose a reason for hiding this comment

joe-elliott Mar 19, 2024

Choose a reason for hiding this comment

knylander-grafana left a comment

Choose a reason for hiding this comment