Skip to main content

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.

FeaturePurposeLocationOutput
DiagnosticsGenerate troubleshooting dataChat input toolbarZIP file with system info, logs, and session data
Report a BugSubmit bug reportsSettings → Help & feedbackOpens GitHub issue template
Request a FeatureSuggest new featuresSettings → Help & feedbackOpens 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

  1. In an active chat session, look for the icon in the bottom toolbar
  2. Click the diagnostics button
  3. Review the information in the modal about what data will be collected
  4. Click Download to generate and save the diagnostics bundle
  5. The ZIP file will be saved as diagnostics_{session_id}.zip
tip

The diagnostics button is only available when you have an active session, as it needs a session ID to generate the bundle.

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
Privacy Notice

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

  1. Click the button in the top-left to open the sidebar
  2. Click Settings in the sidebar
  3. Scroll down to the Help & feedback section
  4. Click Report a Bug
  5. This opens GitHub in your browser with a pre-filled bug report template

Feature Requests

The feature request system helps you suggest improvements and new functionality for goose.

Submitting Feature Requests

  1. Click the button in the top-left to open the sidebar
  2. Click Settings in the sidebar
  3. Scroll down to the Help & feedback section
  4. Click Request a Feature
  5. This opens GitHub in your browser with a feature request template

Additional Debugging

For issues not resolved by diagnostics: