Troubleshooting diagnostics doc (#5526)
This commit is contained in:
@@ -207,6 +207,45 @@ goose session export --path ./my-session.jsonl --output exported.md
|
||||
|
||||
---
|
||||
|
||||
#### session diagnostics [options]
|
||||
Generate a comprehensive diagnostics bundle for troubleshooting issues with a specific session.
|
||||
|
||||
**Options:**
|
||||
- **`-i, --id <id>`**: Generate diagnostics for a specific session by ID
|
||||
- **`-n, --name <name>`**: Generate diagnostics for a specific session by name
|
||||
- **`-o, --output <file>`**: Save diagnostics bundle to a specific file path (default: `diagnostics_{session_id}.zip`)
|
||||
|
||||
**What's included:**
|
||||
- **System Information**: App version, operating system, architecture, and timestamp
|
||||
- **Session Data**: Complete conversation messages and history for the specified session
|
||||
- **Configuration Files**: Your [configuration files](/docs/guides/config-files) (if they exist)
|
||||
- **Log Files**: Recent application logs for debugging
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
# Generate diagnostics for a specific session by ID
|
||||
goose session diagnostics --id 20250305_113223
|
||||
|
||||
# Generate diagnostics for a session by name
|
||||
goose session diagnostics --name my-project-session
|
||||
|
||||
# Save diagnostics to a custom location
|
||||
goose session diagnostics --id 20250305_113223 --output /path/to/my-diagnostics.zip
|
||||
|
||||
# Interactive selection (prompts you to choose a session)
|
||||
goose session diagnostics
|
||||
```
|
||||
|
||||
:::warning 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.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
Generate diagnostics before reporting bugs to provide technical details that help with faster resolution. The ZIP file can be attached to GitHub issues or shared with support.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
### Task Execution
|
||||
|
||||
#### run [options]
|
||||
|
||||
@@ -78,7 +78,7 @@ When in doubt, deny.
|
||||
Beyond prompt injection detection, goose automatically:
|
||||
- Warns you before running new or updated recipes
|
||||
- Warns you when importing recipes that contain invisible Unicode Tag Block characters
|
||||
- [Checks for known malware](/docs/troubleshooting#malicious-package-detected) when installing extensions for locally-run MCP servers
|
||||
- [Checks for known malware](/docs/troubleshooting/known-issues#malicious-package-detected) when installing extensions for locally-run MCP servers
|
||||
:::
|
||||
|
||||
### Configuring Detection Threshold
|
||||
|
||||
@@ -263,7 +263,7 @@ Search allows you to find specific content within sessions or find specific sess
|
||||
```
|
||||
|
||||
:::tip
|
||||
While you can resume sessions using the commands above, we recommend creating new sessions for new tasks to reduce the chance of [doom spiraling](/docs/troubleshooting#stuck-in-a-loop-or-unresponsive).
|
||||
While you can resume sessions using the commands above, we recommend creating new sessions for new tasks to reduce the chance of [doom spiraling](/docs/troubleshooting/known-issues#stuck-in-a-loop-or-unresponsive).
|
||||
:::
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
@@ -54,4 +54,4 @@ Use [lead/worker model](/docs/tutorials/lead-worker/) to have goose use a "lead"
|
||||
Write [recipes](/docs/guides/recipes/session-recipes) that check your current state before acting, so they can be run multiple times without causing any errors or duplication.
|
||||
|
||||
### Add Logging to Recipes
|
||||
Inlcude informative log messages in your recipes for each major step to make debugging and troubleshooting easier should something fail.
|
||||
Include informative log messages in your recipes for each major step to make debugging and troubleshooting easier should something fail.
|
||||
|
||||
Reference in New Issue
Block a user