[docs] Add profiling spans and options for aspire add command#1037
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
[docs] Add profiling spans and options for aspire add command#1037aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Documents the --capture-profile and --capture-profile-output options for aspire add, and the new profiling spans and tags introduced by microsoft/aspire#17347. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
8 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Aspire CLI aspire add command reference to document the new OpenTelemetry profiling capture options and emitted spans/tags introduced for profiling the add flow.
Changes:
- Documented
--capture-profileand--capture-profile-outputoptions foraspire add. - Added a “Profiling spans” section listing span names and associated tags.
- Added an example command showing how to capture a profiling trace to a ZIP file.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Adds the **redis** integration and captures a profiling trace to a ZIP file: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| aspire add redis --version 9.5.0 --capture-profile --capture-profile-output add-redis.zip |
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#17347 by
@davidfowl.Targeting
release/13.4based on the source PR milestone13.4.Why this PR is needed
PR microsoft/aspire#17347 instruments the
aspire addcommand with OpenTelemetry profiling spans so that--capture-profilecaptures where time is spent during package search, selection, and installation. Theaspire-addcommand reference page previously had no mention of--capture-profile,--capture-profile-output, the new span names, or the add-specific OpenTelemetry tags.What was changed
src/frontend/src/content/docs/reference/cli/commands/aspire-add.mdxto document:--capture-profileoption--capture-profile-outputoptionaspire/cli/add*span names with descriptionsaspire.cli.add.integration.name,version_specified,source_specified,configured_channel,package.search_result_count,package.match_count,package.match_kind,package.id,package.version,package.channel, andpackage.successaspire add redis --capture-profile --capture-profile-output add-redis.zipFiles modified
src/frontend/src/content/docs/reference/cli/commands/aspire-add.mdx(updated)