[docs] Add --search option documentation to CLI command reference pages - #1107
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
Closed
[docs] Add --search option documentation to CLI command reference pages#1107aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Documents the --search option for aspire logs, aspire otel logs, aspire otel spans, and aspire otel traces commands, including the updated description mentioning full-text search, field filters, and the https://aka.ms/aspire/cli-search reference link. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
Merged
8 tasks
David Pine (IEvangelist)
marked this pull request as ready for review
May 28, 2026 00:50
David Pine (IEvangelist)
requested review from
David Pine (IEvangelist) and
Mitch Denny (mitchdenny)
as code owners
May 28, 2026 00:50
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for the --search option across Aspire CLI command reference pages, aligning the docs with the CLI behavior introduced in microsoft/aspire#17544.
Changes:
- Documented
--search <query>foraspire logs. - Documented
--search <query>foraspire otel logs,aspire otel spans, andaspire otel traces, including the shared syntax link tohttps://aka.ms/aspire/cli-search.
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 | Adds --search option documentation for log content filtering. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx | Adds --search option documentation for telemetry log searching/filtering. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx | Adds --search option documentation for span searching/filtering. |
| src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx | Adds --search option documentation for trace searching/filtering. |
💡 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#17544 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
PR microsoft/aspire#17544 updated the
--searchoption description for theaspire logsandaspire otelcommands to clarify that it supports full-text search and field filters, and added a link to(aka.ms/redacted) However, none of the CLI command reference pages currently document the--search` option at all, leaving users without any reference for this filtering capability.What was changed
The
--searchoption was added to four CLI command reference pages:aspire-logs.mdx— added--searchoption with description matching the updatedLogsCommandStrings.resx: full-text search to filter log content, with link to aka.ms/aspire/cli-search.aspire-otel-logs.mdx— added--searchoption with description matchingTelemetryCommandStrings.resx: search and filter telemetry fields including log messages, attribute values, names, source, and IDs; supports full-text search and field filters; link to aka.ms/aspire/cli-search.aspire-otel-spans.mdx— added--searchoption with equivalent telemetry search description.aspire-otel-traces.mdx— added--searchoption with equivalent telemetry search description.Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx