Skip to content

Document aspire export zip file contents#804

Open
Copilot wants to merge 3 commits intomainfrom
copilot/update-aspire-export-zip-contents
Open

Document aspire export zip file contents#804
Copilot wants to merge 3 commits intomainfrom
copilot/update-aspire-export-zip-contents

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 4, 2026

The aspire export command reference lacked details about what the exported zip archive actually contains. Added based on the actual ExportArchive.cs implementation (ref: microsoft/aspire#16719).

  • Added "Zip file contents" section documenting the four directories in the archive:
    • resources/ — per-resource JSON with state, endpoints, env vars
    • consolelogs/ — per-resource plain-text console output
    • structuredlogs/ — per-resource OTLP-format structured logs
    • traces/ — per-resource OTLP-format distributed traces
  • Noted filtering behavior when a resource name is provided vs. omitted
  • Added a tip for navigating the export (resources/ first for overview, then telemetry dirs)

@JamesNK JamesNK marked this pull request as ready for review May 4, 2026 14:59
@JamesNK JamesNK requested a review from IEvangelist as a code owner May 4, 2026 14:59
Copilot AI review requested due to automatic review settings May 4, 2026 14:59
@JamesNK JamesNK requested a review from mitchdenny as a code owner May 4, 2026 14:59
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds missing reference documentation for what aspire export writes into the exported ZIP archive, helping users understand and navigate the exported diagnostics bundle.

Changes:

  • Documented the four top-level directories that may appear in the exported archive (resources/, consolelogs/, structuredlogs/, traces/).
  • Clarified how export scoping differs when a resource name is provided vs. omitted.
  • Added a navigation tip for analyzing exports (start with resources/, then telemetry directories).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/frontend/src/content/docs/reference/cli/commands/aspire-export.mdx Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants