[docs] Document timestamp search qualifier for telemetry filtering#1181
Conversation
Documents the new 'timestamp' search qualifier added in microsoft/aspire#17816. Users can now filter traces and structured logs by date/time using ISO 8601 strings with comparison operators (>, >=, <, <=) in the dashboard filter bar. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
@copilot Details about timestamp filtering should be on the search-filter.mdx page. Also update aspire-otel-logs.mdx and aspire-otel-traces.mdx and aspire-otel-spans.mdx |
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Addressed in 2a30024. The timestamp qualifier details now live in |
| - A value with no timezone suffix (for example `2024-01-15T09:30:00`) is treated as local time on the dashboard server. | ||
| - A value with a UTC offset (for example `+05:00`) is adjusted to UTC before comparison. | ||
| - A value with the `Z` suffix is treated as UTC directly. |
There was a problem hiding this comment.
@copilot Mention that time is optional. An ISO date by itself can be used as a value
Co-authored-by: James Newton-King <james@newtonking.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
|
@IEvangelist this should be on 13.5 branch |
There was a problem hiding this comment.
Pull request overview
Documents the new timestamp search qualifier (added in microsoft/aspire#17816) so users can filter structured logs, traces, and spans by date/time using ISO 8601 values and comparison operators across the Aspire CLI telemetry commands.
Changes:
- Added shared documentation for the
timestamp:qualifier (syntax, operators, and timezone semantics) in the CLI search/filter reference. - Updated
aspire otel logs|traces|spanscommand references to listtimestampas a supported field and include timestamp-based filter examples. - Removed duplicated qualifier details from the dashboard “Explore” page so the canonical syntax lives in the shared reference doc.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/cli/search-filter.mdx | Adds the canonical timestamp qualifier documentation and updates supported field lists/examples. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx | Lists timestamp as a supported search field and adds a timestamp filtering example. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx | Expands comparison/field documentation to include timestamp and adds a timestamp filtering example. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx | Expands comparison/field documentation to include timestamp and adds a timestamp filtering example. |
| src/frontend/src/content/docs/dashboard/explore.mdx | Removes duplicated timestamp qualifier details from the dashboard tour page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
IEvangelist
left a comment
There was a problem hiding this comment.
Docs-from-code reviewer — branch mismatch, cannot verify
This PR targets
elease/13.5 on microsoft/aspire.dev, but microsoft/aspire has no matching release/13.5 branch (latest release branch upstream is release/13.4 at 59e06a48d2b09bc2b3efa6ac9ea6b38336b88c4b).
The referenced source PR, microsoft/aspire#17816, was merged into main as commit 2551bddee0f5e835224bc4a7014744625ec56ce3. Per this reviewer's rules I only verify against the matching release branch, so I'm skipping claim verification (Phase A) and the doc-tester run (Phase B) for this PR.
Once release/13.5 exists in microsoft/aspire (or this PR is retargeted to a branch that does exist there, e.g. release/13.4), I'll perform the full review on the next hourly run.
Head SHA reviewed: 5456a75b354639067c79fa07611bd895c2ae1ece
|
I can't process this review feedback automatically because this PR targets I checked the local |
|
[docs-feedback responder] I selected this PR for the hourly docs-feedback pass, but it targets Per the source-of-truth rule, I can't evaluate API/behavior feedback or edit docs without a matching |
IEvangelist
left a comment
There was a problem hiding this comment.
Source-of-truth branch mismatch — review skipped
Cannot verify this PR against microsoft/aspire.
PR base branch (microsoft/aspire.dev) |
release/13.5 |
Matching branch in microsoft/aspire |
does not exist |
Latest release branch in microsoft/aspire |
release/13.4 (4f218933) |
| Source PR cited in body | microsoft/aspire#17816 — merged to main on 2026-06-02, milestone 13.5 |
My review protocol requires using the matching microsoft/aspire release branch as the single source of truth for claim verification. Because no release/13.5 branch exists in microsoft/aspire yet (13.5 has not been cut), I cannot verify the CLI / search-filter claims in this PR against an authoritative source-code snapshot for that release.
The only revision since my prior review (5456a75b → 382df14d) was a one-line example fix in search-filter.mdx (expanding the +05:00 UTC-offset example to a full ISO 8601 timestamp) and does not change this verdict.
Possible resolutions:
- Re-target this PR to
release/13.4inaspire.devif the documented behavior is already present in 13.4. - Wait until
release/13.5is cut inmicrosoft/aspire, then re-run review against that branch.
Skipping Phase B (doc-tester) as well — per protocol, running it without Phase A claim verification would produce an incomplete review.
Documents changes from microsoft/aspire#17816 by
@JamesNK.Targeting
release/13.4— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.5(from the source PR milestone13.5) does not exist there.Why this PR is needed
microsoft/aspire#17816 adds a
timestampsearch qualifier to the Aspire Dashboard, allowing users to filter traces, spans, and structured logs by date/time using ISO 8601 strings with comparison operators (>,>=,<,<=). This is a new user-facing feature with no prior documentation on the docs site.What was changed
src/frontend/src/content/docs/reference/cli/search-filter.mdxto document the sharedtimestampqualifier syntax for telemetry search filtering.timestamp:qualifier syntax with example filter expressions for logs, traces, and spans.Zsuffix values are UTC.timestampas a supported search field and add timestamp-based examples:src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdxsrc/frontend/src/content/docs/dashboard/explore.mdxso the detailed qualifier documentation lives in the shared CLI reference instead of being duplicated on the dashboard page.Files modified
src/frontend/src/content/docs/reference/cli/search-filter.mdx(updated — added sharedtimestampqualifier documentation)src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx(updated — addedtimestampsearch field/details and example)src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx(updated — addedtimestampsearch field/details and example)src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx(updated — addedtimestampsearch field/details and example)src/frontend/src/content/docs/dashboard/explore.mdx(updated — removed duplicated timestamp qualifier details)> Generated by PR Documentation Check for issue #17816 · ● 11M · ◷