Diagnostics and Reporting
goose provides several built-in features to help you get support, report issues, and request new functionality. This guide covers the diagnostics system, bug reporting, and feature request tools.
| Feature | Purpose | Location | Output |
|---|---|---|---|
| Diagnostics | Generate troubleshooting data | Chat input toolbar | ZIP file with system info, logs, and session data |
| Report a Bug | Submit bug reports | Settings → Help & feedback | Opens GitHub issue template |
| Request a Feature | Suggest new features | Settings → Help & feedback | Opens GitHub issue template |
Diagnostics System
The diagnostics feature creates a comprehensive troubleshooting bundle that includes system information, session data, configuration files, and recent logs. This is invaluable for debugging issues or getting technical support.
Generating Diagnostics
- goose Desktop
- goose CLI
- In an active chat session, look for the icon in the bottom toolbar
- Click the diagnostics button
- Review the information in the modal about what data will be collected
- Click
Downloadto generate and save the diagnostics bundle - The ZIP file will be saved as
diagnostics_{session_id}.zip
The diagnostics button is only available when you have an active session, as it needs a session ID to generate the bundle.
Use the session diagnostics command to generate a troubleshooting bundle. For complete details and all available options, see the CLI Commands guide.
# Generate diagnostics for a specific session
goose session diagnostics --id <session_id>
# Interactive selection (prompts you to choose a session)
goose session diagnostics
# Save to a custom location
goose session diagnostics --id <session_id> --output /path/to/diagnostics.zip
To find your session ID, first list available sessions:
goose session list
Example output:
Available sessions:
abc123def - My coding session - 2024-01-15 14:30:22
xyz789ghi - Documentation work - 2024-01-15 10:15:45
Using Diagnostics Data
The diagnostics ZIP file contains several folders:
diagnostics_abc123def.zip
├── logs/
│ ├── goose-2024-01-15.jsonl
│ ├── goose-2024-01-14.jsonl
│ └── ...
├── session.json # Your session messages
├── config.yaml # Configuration files (if they exist)
└── system.txt # System information
When to generate diagnostics:
- Experiencing crashes or unexpected behavior
- Getting error messages you don't understand
- Performance issues or slow responses
- Before reporting bugs to include technical details
What's included in diagnostics:
- System Information: App version, operating system, architecture, and timestamp
- Session Data: Your current conversation messages and history
- Configuration Files: Your configuration files (if they exist)
- Log Files: Recent application logs for debugging
Diagnostics bundles contain your session messages and system information. If your session includes sensitive data (API keys, personal information, proprietary code), review the contents before sharing publicly.
Bug Reports
The bug report feature opens a structured GitHub issue template to help you provide all necessary information for effective bug reporting.
Creating Bug Reports
- goose Desktop
- goose CLI
- Click the button in the top-left to open the sidebar
- Click
Settingsin the sidebar - Scroll down to the
Help & feedbacksection - Click
Report a Bug - This opens GitHub in your browser with a pre-filled bug report template
For CLI users, navigate directly to the GitHub repository:
https://github.com/block/goose/issues/new?template=bug_report.md
Feature Requests
The feature request system helps you suggest improvements and new functionality for goose.
Submitting Feature Requests
- goose Desktop
- goose CLI
- Click the button in the top-left to open the sidebar
- Click
Settingsin the sidebar - Scroll down to the
Help & feedbacksection - Click
Request a Feature - This opens GitHub in your browser with a feature request template
Navigate directly to the GitHub repository:
https://github.com/block/goose/issues/new?template=feature_request.md
Additional Debugging
For issues not resolved by diagnostics:
- Session and System Logs: View detailed logs for debugging individual sessions
- Telemetry Export: Configure telemetry for performance analysis and production monitoring