Skip to content

Document aspire export zip file contents #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamint merged 3 commits into from
May 6, 2026
+15 −0
Merged

Document aspire export zip file contents #804

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fdf1f32
Add zip file contents section to aspire export command reference
Copilot May 4, 2026
7a7469d
Fix italic markdown syntax for .txt file extension
Copilot May 4, 2026
339e26a
Potential fix for pull request finding
JamesNK May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-export.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,21 @@ The following options are available:

- <Include relativePath="reference/cli/includes/option-wait.md" />

## Zip file contents

The exported zip archive (default name `aspire-export-<timestamp>.zip`) can contain up to four directories, depending on available data:

- **`resources/`** — One JSON file per resource containing resource details such as name, type, state, endpoints, and environment variables.
- **`consolelogs/`** — One plain-text `*.txt` file per resource with raw console output lines.
- **`structuredlogs/`** — One JSON file per resource with structured log entries serialized in [OTLP format](https://opentelemetry.io/docs/specs/otlp/).
- **`traces/`** — One JSON file per resource with distributed traces and spans serialized in [OTLP format](https://opentelemetry.io/docs/specs/otlp/).

When a resource name is provided, only data for that resource is included in the archive. When no resource is specified, data for all visible resources is exported.

:::tip
When analyzing an export, start with the `resources/` directory for an overview of resource state, then drill into `consolelogs/`, `structuredlogs/`, and `traces/` for detailed diagnostics.
:::

## Examples

- Export diagnostics for the current AppHost:
Expand Down
Loading