[docs] Document --search option for aspire logs and aspire otel commands - #1110
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
Closed
[docs] Document --search option for aspire logs and aspire otel commands#1110aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Add the --search option to the CLI reference documentation for: - aspire logs - aspire otel logs - aspire otel spans - aspire otel traces The --search option supports full-text search and field filters, with a reference link to https://aka.ms/aspire/cli-search for full syntax details. Documents changes from microsoft/aspire#17568. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
David Pine (IEvangelist)
marked this pull request as ready for review
May 28, 2026 06:56
David Pine (IEvangelist)
requested review from
David Pine (IEvangelist) and
Mitch Denny (mitchdenny)
as code owners
May 28, 2026 06:56
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the newly added --search option for Aspire CLI log/telemetry commands so the CLI reference matches the updated help text from microsoft/aspire#17568.
Changes:
- Added
--search <search>option documentation toaspire logsandaspire otel(logs/spans/traces) command reference pages. - Added concrete
--searchusage examples to theaspire logsandaspire otel logspages. - Linked to the CLI search syntax documentation (
https://aka.ms/aspire/cli-search) from each affected command page.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdx | Documented --search and added a search example for aspire logs. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx | Documented --search and added a search example for aspire otel logs. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx | Documented --search for aspire otel spans. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx | Documented --search for aspire otel traces. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#17568.
Author:
@JamesNKTarget branch: Targeting
release/13.4based on the source PR milestone13.4.Why this PR is needed
The
--searchoption was added to theaspire logsandaspire otel(logs, spans, traces) commands but was not documented in the CLI reference. PR microsoft/aspire#17568 updated the CLI help text for the--searchoption to clarify that it supports full-text search and field filters, and added a link to(aka.ms/redacted) This PR adds the--search` option to the corresponding documentation pages.Changes
Updated pages
src/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdx— Added--searchoption and a search examplesrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx— Added--searchoption and a search examplesrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx— Added--searchoptionsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx— Added--searchoption