Bugs

Bugs

🐌 🦋 🐛 🐜 🐝 🐞

Bugs are part of an apps life. They mean you no harm, but they are not here to stay either 😠.

What are bugs?

• If the app crashes it is obviously a bug
• If something is behaving unexpectedly, it could be a bug.

In any case check that you are on the latest update, the bug might already be fixed.

If the bug isn't fixed, then report it 😁.

Reporting a bug

Create an issue ticket on GitHub: https://github.com/d4rken-org/butler/issues

• Describe what you expected and what actually happened
• List the steps that someone else would have to take to reproduce the issue
• Describe your setup
  • Your device type (e.g. Pixel 5)
  • Android version (e.g. Android 13.1)
  • If you are rooted, the Magisk version

Include a debug log if you can reproduce the issue.

Debug log

A debug log is a recording of Butler's action. You start the recording, reproduce the issue, then stop it and can share a zip file with a chronological account of what Butler did.

To start recording a debug log:

• Go to settings in Butler by pressing the settings icon in the bottom right of the dashboard
• Find the Support entry in the settings list
• Click Debug log on the support screen
• A new notification from Butler will pop up and notify you that a log is being recorded (make sure you have given Butler notification permission).
• Now reproduce the issue you want to record
• Once you have reproduced the issue, open your notifications and find the debug log notification from Butler
• Press the Done button in the notification. If the Done action is not visible, expand the notification.
• After a short moment you will get a popup that allows you to share the compressed log file.

The debug log will be recorded until you stop it, the recording will continue, even if you force-stop and restart Butler.

If you are troubleshooting issues related to core functionality, e.g. root detection or detected storage areas, it is useful to force-stop and restart Butler while recording as some data is only initialized once per app session.

The debug log files are stored in /storage/emulated/0/Android/data/eu.darken.butler/cache/debug/logs.

In pictures: