Affected scope
project: foundry
Problem to solve
When users report issues, collecting useful logs from Foundry OSD, Foundry Deploy, and Foundry Connect is still too manual. Users may not know where logs are stored, which files are relevant, or how to package them for a GitHub issue.
This makes troubleshooting slower and can lead to incomplete bug reports.
Proposed solution
Add an easy log export workflow that packages relevant diagnostic files into a ZIP archive.
The export should support:
- Foundry OSD logs.
- Foundry Deploy logs.
- Foundry Connect logs.
- Deployment session logs when available.
- Runtime state or configuration diagnostics only when safe to include.
The export should:
- Be accessible from each application where possible.
- Create a ZIP file with a clear timestamped name.
- Include only useful support artifacts.
- Redact or exclude sensitive data such as secrets, tokens, passwords, Wi-Fi passphrases, certificates, private keys, and media secret keys.
- Include basic environment metadata when safe, such as app name, app version, runtime mode, architecture, and Windows version.
- Make the exported file easy to attach to a GitHub issue.
Alternatives considered
Users can manually collect logs from the known log directories, but this requires knowledge of internal paths and can miss important files. Asking users to paste logs directly into GitHub issues is also less reliable and can expose sensitive data more easily.
Use case
A user opens a GitHub issue after a media creation, network bootstrap, or OS deployment problem. They can click an export action, attach the generated ZIP, and provide maintainers with enough diagnostics to investigate without multiple back-and-forth messages.
Checklist
Affected scope
project: foundry
Problem to solve
When users report issues, collecting useful logs from Foundry OSD, Foundry Deploy, and Foundry Connect is still too manual. Users may not know where logs are stored, which files are relevant, or how to package them for a GitHub issue.
This makes troubleshooting slower and can lead to incomplete bug reports.
Proposed solution
Add an easy log export workflow that packages relevant diagnostic files into a ZIP archive.
The export should support:
The export should:
Alternatives considered
Users can manually collect logs from the known log directories, but this requires knowledge of internal paths and can miss important files. Asking users to paste logs directly into GitHub issues is also less reliable and can expose sensitive data more easily.
Use case
A user opens a GitHub issue after a media creation, network bootstrap, or OS deployment problem. They can click an export action, attach the generated ZIP, and provide maintainers with enough diagnostics to investigate without multiple back-and-forth messages.
Checklist