Add profiling spans for aspire add#17347
Merged
Merged
Conversation
Instrument the add command with profiling spans for AppHost discovery, package search and selection, running instance cleanup, and package installation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17347Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17347" |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds profiling-only Activity spans to the Aspire CLI’s aspire add flow so --capture-profile exports clearly show where time is spent while discovering an AppHost, resolving channels/packages, stopping running instances, and installing the selected integration.
Changes:
- Introduced
aspire/cli/add*profiling span names and add-specific tags inProfilingTelemetry. - Instrumented
AddCommandto emit spans for AppHost discovery, configured channel lookup, package search/selection, stopping running instances, and package installation (with relevant tags). - Added a unit test validating the add-specific spans/tags are created and carry the profiling session context.
Show a summary per file
| File | Description |
|---|---|
| src/Aspire.Cli/Telemetry/ProfilingTelemetry.cs | Adds add-command span names/tags and helper APIs to create/annotate add-specific profiling activities. |
| src/Aspire.Cli/Commands/AddCommand.cs | Wraps key aspire add stages in profiling spans and emits add-specific tags (selection, counts, language, install result). |
| tests/Aspire.Cli.Tests/Telemetry/ProfilingTelemetryTests.cs | Adds coverage ensuring add-specific spans are created with expected operation names, tags, and session propagation. |
Copilot's findings
- Files reviewed: 3/3 changed files
- Comments generated: 0
mitchdenny
reviewed
May 21, 2026
mitchdenny
reviewed
May 21, 2026
Member
mitchdenny
left a comment
mitchdenny
left a comment
There was a problem hiding this comment.
Reviewed the new aspire add profiling spans. Instrumentation is mostly clean and the unit tests cover each new scope and tag. Flagging three observability concerns — one moderate (1), two minor (2, 3).
mitchdenny
approved these changes
May 21, 2026
Separate interactive package selection prompts from the select-package span, record package match kind, and mark the root add profiling span on graceful failure paths. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
❓ CLI E2E Tests unknown — 95 passed, 0 failed, 5 unknown (commit View all recordings
📹 Recordings uploaded automatically from CI run #26237621259 |
aspire-repo-bot Bot
added a commit
to microsoft/aspire.dev
that referenced
this pull request
May 21, 2026
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>
Contributor
|
Pull request created: #1037
|
Contributor
|
📝 Documentation has been drafted in microsoft/aspire.dev#1037 targeting Updated Note This draft PR needs human review before merging. |
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.
Description
Instruments
aspire addwith profiling spans so that--capture-profilecaptures where add time is spent — package search, package selection, and installation — alongside the existing run/ls profiling.What changed
New profiling spans in
ProfilingTelemetry:aspire/cli/add— root span for the whole add commandaspire/cli/add.find_apphost— AppHost project discoveryaspire/cli/add.get_configured_channel— NuGet channel lookup via msbuildaspire/cli/add.search_packages—dotnet package searchfor Aspire integrationsaspire/cli/add.select_package— records match count/kind and selected package (dispatch only, no user think time)aspire/cli/add.select_package.prompt— wraps interactive package/version prompts so user think time is filterableaspire/cli/add.stop_existing_instance— stopping any running AppHost before addaspire/cli/add.package—dotnet package addinstallationNew tags:
aspire.cli.add.integration.name,version_specified,source_specified,configured_channel,package.search_result_count,package.match_count,package.match_kind(exact/fuzzy/none),package.id,package.version,package.channel,package.successRoot
aspire/cli/addspan is marked with error status and exit code on all graceful failure paths (not just thrown exceptions).User-facing usage
Sample profile output (from
SimplePipelines.AppHostplayground):dotnet package searchanddotnet package addeach appear as childprocess dotnetspans so it's easy to see which subprocess dominates add time.Checklist