Skip to content

[docs] Document timestamp search qualifier for telemetry filtering#1181

Merged
JamesNK merged 10 commits into
release/13.5from
docs/timestamp-filter-qualifier-17816-7b6dbcc69cf434a4
Jun 6, 2026
Merged

[docs] Document timestamp search qualifier for telemetry filtering#1181
JamesNK merged 10 commits into
release/13.5from
docs/timestamp-filter-qualifier-17816-7b6dbcc69cf434a4

Conversation

@aspire-repo-bot

@aspire-repo-bot aspire-repo-bot Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#17816 by @JamesNK.

Targeting release/13.4 — the latest release branch on microsoft/aspire.dev — because release/13.5 (from the source PR milestone 13.5) does not exist there.

Why this PR is needed

microsoft/aspire#17816 adds a timestamp search 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

  • Updated src/frontend/src/content/docs/reference/cli/search-filter.mdx to document the shared timestamp qualifier syntax for telemetry search filtering.
    • Documents the timestamp: qualifier syntax with example filter expressions for logs, traces, and spans.
    • Explains timezone handling: no-suffix values are treated as server local time, offset values are adjusted to UTC, and Z suffix values are UTC.
  • Updated the command reference pages to list timestamp as a supported search field and add timestamp-based examples:
    • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx
    • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx
    • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx
  • Restored src/frontend/src/content/docs/dashboard/explore.mdx so 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 shared timestamp qualifier documentation)
  • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx (updated — added timestamp search field/details and example)
  • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx (updated — added timestamp search field/details and example)
  • src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx (updated — added timestamp search 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 ·

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>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Jun 2, 2026
@aspire-repo-bot
aspire-repo-bot Bot requested a review from mitchdenny June 2, 2026 08:33
@JamesNK

JamesNK commented Jun 4, 2026

Copy link
Copy Markdown
Member

@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

Copilot AI and others added 2 commits June 4, 2026 08:10
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

@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

Addressed in 2a30024. The timestamp qualifier details now live in reference/cli/search-filter.mdx, aspire-otel-logs.mdx, aspire-otel-traces.mdx, and aspire-otel-spans.mdx, and the duplicated detail was removed from dashboard/explore.mdx.

Copilot AI requested a review from JamesNK June 4, 2026 08:12
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/search-filter.mdx Outdated
Comment on lines +47 to +49
- 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot Mention that time is optional. An ISO date by itself can be used as a value

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.

Addressed in 38fb43f.

Comment thread src/frontend/src/content/docs/reference/cli/search-filter.mdx Outdated
Co-authored-by: James Newton-King <james@newtonking.com>
Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx Outdated
Comment thread src/frontend/src/content/docs/reference/cli/search-filter.mdx Outdated
JamesNK and others added 2 commits June 4, 2026 16:19
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Copilot AI requested a review from JamesNK June 4, 2026 08:22
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1181. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1181 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@JamesNK
JamesNK marked this pull request as ready for review June 4, 2026 14:27
@JamesNK
JamesNK requested a review from IEvangelist as a code owner June 4, 2026 14:27
Copilot AI review requested due to automatic review settings June 4, 2026 14:27
@JamesNK

JamesNK commented Jun 4, 2026

Copy link
Copy Markdown
Member

@IEvangelist this should be on 13.5 branch

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

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|spans command references to list timestamp as 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.

Comment thread src/frontend/src/content/docs/reference/cli/search-filter.mdx Outdated
@IEvangelist
IEvangelist changed the base branch from release/13.4 to release/13.5 June 5, 2026 20:36
@IEvangelist
IEvangelist requested a review from JamesNK June 5, 2026 21:47

@IEvangelist IEvangelist left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

@IEvangelist

Copy link
Copy Markdown
Member

I can't process this review feedback automatically because this PR targets release/13.5, but the required source-of-truth branch release/13.5 does not exist in microsoft/aspire.

I checked the local microsoft/aspire clone remotes and https://github.com/microsoft/aspire.git; available release branches include release/13.0 through release/13.4, but not release/13.5. Per the docs-feedback workflow, I'm stopping without making doc edits or resolving threads so a human can confirm the correct source branch.

@IEvangelist

Copy link
Copy Markdown
Member

[docs-feedback responder]

I selected this PR for the hourly docs-feedback pass, but it targets release/13.5 and the local microsoft/aspire source clone (https://github.com/microsoft/aspire.git) has no matching origin/release/13.5 head (git ls-remote --heads origin release/13.5 returned no match).

Per the source-of-truth rule, I can't evaluate API/behavior feedback or edit docs without a matching microsoft/aspire branch. No changes were made.

Comment thread src/frontend/src/content/docs/reference/cli/search-filter.mdx Outdated

@IEvangelist IEvangelist left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 (5456a75b382df14d) 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:

  1. Re-target this PR to release/13.4 in aspire.dev if the documented behavior is already present in 13.4.
  2. Wait until release/13.5 is cut in microsoft/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.

Comment thread src/frontend/src/content/docs/reference/cli/search-filter.mdx Outdated
@JamesNK
JamesNK enabled auto-merge (squash) June 6, 2026 05:05
@JamesNK
JamesNK merged commit a2d5b95 into release/13.5 Jun 6, 2026
9 checks passed
@JamesNK
JamesNK deleted the docs/timestamp-filter-qualifier-17816-7b6dbcc69cf434a4 branch June 6, 2026 05:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants