[docs] aspire logs: document --search option#948
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
Conversation
Documents the --search / -s option added in microsoft/aspire#17010, including server-side filtering behavior when connected to a v2+ AppHost auxiliary backchannel. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the previously-undocumented --search / -s option for aspire logs, reflecting recent CLI improvements for server-side log filtering to reduce overhead on large log streams.
Changes:
- Expands the
aspire logsdescription to mention full-text log searching/filtering. - Adds documentation for
-s, --search <search>, including a note about server-side filtering when supported. - Adds examples showing basic search and search combined with
--tailfor a specific resource.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - **`-s, --search <search>`** | ||
|
|
||
| Full-text search to filter log content. Only log lines whose message or resource name contains the specified text are shown. When connected to an AppHost that supports the v2 or later auxiliary backchannel, filtering is applied server-side before log lines are transferred, which significantly reduces overhead for large log streams. |
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#17010 by
@davidfowl.Targeting
release/13.4based on the source PR milestone13.4.Why this PR is needed
PR microsoft/aspire#17010 added server-side log search filtering to the
aspire logscommand, dramatically reducing overhead when searching large log streams (131s → 0.9s in a 75,000-line benchmark). The--search/-soption was already present in the CLI but was not documented in the reference docs. This PR adds the missing option documentation.Changes
src/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdx:--search <search>/-soption entry, including a note about automatic server-side filtering when connected to a v2+ AppHost backchannel.--searchwith--tailfor a specific resource.Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-logs.mdx(updated)