Skip to content

docs: document Tempo HTTP API and Grafana Traces Drilldown#195

Open
vshulakov-sh wants to merge 1 commit into
VictoriaMetrics:masterfrom
vshulakov-sh:docs-tempo-api-drilldown
Open

docs: document Tempo HTTP API and Grafana Traces Drilldown#195
vshulakov-sh wants to merge 1 commit into
VictoriaMetrics:masterfrom
vshulakov-sh:docs-tempo-api-drilldown

Conversation

@vshulakov-sh

@vshulakov-sh vshulakov-sh commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Describe Your Changes

Closes #191.

Since v0.9.0 VictoriaTraces extended its Tempo API / TraceQL support, enabling the Grafana Tempo datasource and the Grafana Traces Drilldown feature, but this was not yet documented. This PR documents it:

  • Adds a "Tempo HTTP API" section to the querying docs listing all supported /select/tempo/* endpoints, the version each was introduced in, and how they work — trace search (TraceQL), tag/value auto-completion, trace-by-id (v1 & v2), and TraceQL metrics — with curl examples and the TraceQL → LogsQL attribute mapping.
  • Expands the Grafana Tempo datasource doc with cluster (vtselect) URL guidance and a "Grafana Traces Drilldown" setup section that links to the endpoints it relies on.

Docs only — no code or behavior changes.

Checklist

The following checks are mandatory:

Closes VictoriaMetrics#191. Add a "Tempo HTTP API" section to the querying docs covering
the supported endpoints, the versions they were introduced in, and how each
works (search, tag/value auto-completion, trace-by-id, TraceQL metrics).
Expand the Grafana Tempo datasource doc with cluster URL guidance and a
Traces Drilldown setup section linking to the relevant endpoints.

@cubic-dev-ai cubic-dev-ai Bot 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.

1 issue found across 2 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/victoriatraces/querying/README.md">

<violation number="1" location="docs/victoriatraces/querying/README.md:260">
P2: The example claims to query traces 'over the last hour' but omits `start` and `end` parameters. Per the documented defaults, omitting these parameters searches only the last 10 minutes, creating a mismatch between the example description and actual behavior.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

- `start`, `end`: the time range boundaries as Unix timestamps. When omitted, the last 10 minutes are used.
- `limit`: the maximum number of traces to return, clamped to the `[0, 1000]` range. Default `100`.

For example, to find traces of the `frontend` service with status `error` over the last hour:

@cubic-dev-ai cubic-dev-ai Bot Jun 25, 2026

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.

P2: The example claims to query traces 'over the last hour' but omits start and end parameters. Per the documented defaults, omitting these parameters searches only the last 10 minutes, creating a mismatch between the example description and actual behavior.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/victoriatraces/querying/README.md, line 260:

<comment>The example claims to query traces 'over the last hour' but omits `start` and `end` parameters. Per the documented defaults, omitting these parameters searches only the last 10 minutes, creating a mismatch between the example description and actual behavior.</comment>

<file context>
@@ -221,6 +221,101 @@ Some valid filter examples:
+- `start`, `end`: the time range boundaries as Unix timestamps. When omitted, the last 10 minutes are used.
+- `limit`: the maximum number of traces to return, clamped to the `[0, 1000]` range. Default `100`.
+
+For example, to find traces of the `frontend` service with status `error` over the last hour:
+
+```sh
</file context>
Suggested change
For example, to find traces of the `frontend` service with status `error` over the last hour:
+For example, to find traces of the `frontend` service with status `error` over the last 10 minutes:
Fix with cubic

@jiekun jiekun self-assigned this Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: enhance doc for Tempo API and Grafana drilldown

2 participants