Skip to content

Docs for redact traces, faster read path, find traces arrays - #7144

Merged
knylander-grafana merged 6 commits into
grafana:mainfrom
knylander-grafana:missing-docs-v3-rel-notes
May 21, 2026
Merged

Docs for redact traces, faster read path, find traces arrays #7144
knylander-grafana merged 6 commits into
grafana:mainfrom
knylander-grafana:missing-docs-v3-rel-notes

Conversation

@knylander-grafana

Copy link
Copy Markdown
Contributor

Add docs for PRs:

Which issue(s) this PR fixes:
Part of docs for release 3.0

Checklist

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds/updates Tempo documentation for three TraceQL/Tempo features that landed in earlier PRs (trace redaction via backend scheduler + tempo-cli, vParquet5 span-only fetch path for metrics, and array matching semantics in TraceQL).

Changes:

  • Clarify TraceQL behavior when comparing attributes that contain arrays (including negated operators).
  • Document tempo-cli redact usage and how it interacts with the backend scheduler.
  • Document the experimental vParquet5 “faster read path” for TraceQL metrics queries and how to enable it.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
docs/sources/tempo/traceql/construct-traceql-queries.md Expands the “arrays” section to spell out =/=~ vs !=/!~ behavior on array-valued attributes.
docs/sources/tempo/operations/tempo_cli.md Adds a new tempo-cli redact section describing usage, flags, output, and where to monitor scheduler job status.
docs/sources/tempo/metrics-from-traces/metrics-queries/_index.md Adds an experimental note describing the vParquet5 span-only metrics read path and enablement knobs (hint + overrides).
Comment thread docs/sources/tempo/metrics-from-traces/metrics-queries/_index.md Outdated
Comment thread docs/sources/tempo/metrics-from-traces/metrics-queries/_index.md Outdated
Comment thread docs/sources/tempo/operations/tempo_cli.md Outdated
- Clarify faster read path requires explicit enablement (hint or override)
- Remove unsafe_query_hints from override example (not required)
- Note hint precedence is conditional on unsafe_query_hints being enabled
- Fix backend-scheduler API docs anchor link
Comment thread docs/sources/tempo/operations/tempo_cli.md
Copilot AI review requested due to automatic review settings May 12, 2026 17:43
Comment thread docs/sources/tempo/operations/tempo_cli.md Outdated
Comment thread docs/sources/tempo/metrics-from-traces/metrics-queries/_index.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.


In vParquet5, you can use an experimental span-only fetch layer to significantly improve performance for most metrics queries. This optimized read path processes individual spans instead of full traces, reducing latency and memory usage.

You must enable the faster read path explicitly using a query hint or a per-tenant override. Once enabled, it applies to metrics queries that don't require knowledge of the full trace structure. Queries using structural operators like `>>`, `<<`, `~`, `!>>`, `!<<`, or `!~` still use the standard fetch layer.
@zalegrala

Copy link
Copy Markdown
Contributor

Looks good to me.

@knylander-grafana
knylander-grafana merged commit 9f50627 into grafana:main May 21, 2026
27 checks passed
knylander-grafana added a commit that referenced this pull request May 22, 2026
…arrays (#7208)

* Docs for redact traces, faster read path, find traces with arrays (6832, 6359, 6353)

* Address review comments on PR #7144

- Clarify faster read path requires explicit enablement (hint or override)
- Remove unsafe_query_hints from override example (not required)
- Note hint precedence is conditional on unsafe_query_hints being enabled
- Fix backend-scheduler API docs anchor link

* Apply suggestion from @knylander-grafana

* Apply suggestion from @knylander-grafana

* Apply suggestion from @knylander-grafana

(cherry picked from commit 9f50627)

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
mattdurham pushed a commit to mattdurham/tempo that referenced this pull request Jun 18, 2026
…#7144)

* Docs for redact traces, faster read path, find traces with arrays (6832, 6359, 6353)

* Address review comments on PR grafana#7144

- Clarify faster read path requires explicit enablement (hint or override)
- Remove unsafe_query_hints from override example (not required)
- Note hint precedence is conditional on unsafe_query_hints being enabled
- Fix backend-scheduler API docs anchor link

* Apply suggestion from @knylander-grafana

* Apply suggestion from @knylander-grafana

* Apply suggestion from @knylander-grafana
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport release-v3.0 type/docs Improvements or additions to documentation

3 participants