Collecting a bug report
Export diagnostics or a single incident, what the files contain, what never to share, and how to report a bug on GitHub.
Export diagnostics
Step 1
Export diagnostics for the whole app
- Open SettingsGeneral.
- Find the Diagnostics card.
- Choose Export Diagnostics… and pick where to save the text file.
The card says what's in it: versions, which settings are on or off, and a redacted tail of the server log. Settings are reported as on or off, not with their values. Murage saves the file readable by your user account only.
You're done when: you have a text file saved where you chose.
Step 2
Read the file before you share it
Open the file and read it. It's plain text, so you can check for yourself.
You're done when: you've checked nothing private slipped through.
Or export one incident
Step 1
Open the error card
When a bot's turn fails, the error card in the chat can show its tracking details: a diagnostic ID, the turn ID, and technical facts such as the error kind or HTTP status.
You're done when: you can see the diagnostic ID on the failed turn.
Step 2
Copy the ID or export the incident
- Copy diagnostic ID copies an ID you can paste into your report.
- Export this incident saves a report about that one failed turn: the app version, your system, and a bounded record of what the engine process did around the failure (starting, requests, stopping), without the conversation itself.
An incident report is the most useful thing you can attach when a specific bot keeps failing.
You're done when: you have an ID to paste, or a saved incident file.
What to put in the report
- Your Murage version (SettingsGeneral) and your system: Mac (Apple Silicon or Intel), Windows or Linux, and whether you installed a release or run from source.
- The bot's engine and model.
- What you did, what you expected, and what happened instead.
- The exact error message, copied as text.
- Whether the same engine works on its own in a terminal.
- The diagnostics file or incident report, after you've read it.
- A screenshot, if the problem is something you can see.
What never to share
Where to send it
Report bugs on GitHub: github.com/FerroxLabs/murage/issues.
Step 1
Search the existing issues
Someone may have reported it already.
You're done when: you've checked whether someone reported it already.
Step 2
Open the bug report form
Choose New issue, then the bug report form.
You're done when: the bug report form is open.
Step 3
Fill it in and attach your diagnostics
Fill in the area, what happened, your version and install, and attach your diagnostics.
You're done when: the issue is filed.
Security problems
Don't report a security vulnerability in a public issue. Report it privately by following the security policy in the Murage repository.
Before you file
Many problems have a quick fix. Check the page for your area first: