Reporting a bug

mina report asks what happened, collects the report and prints it. Once you confirm in an interactive terminal, it opens a pre-filled GitHub issue in your browser. In a noninteractive shell, it prints the report and stops unless you pass --yes. Nothing is posted until you submit the issue yourself.

It reads the node's work directory, ~/.mina unless you give -d DIR.

• this build: its version, commit and build flags;
• the machine: OS, CPU, RAM and free disk;
• what the running node says about itself: sync state, tips, peers and roles;
• the newest crash, if there was one;
• warnings and errors from the end of the log;
• a check of the saved chain state;
• how the node was started.

It never holds private keys or key files, passwords or the values of secret environment variables, tokens, or anything in a web address after its host. Peer IP addresses and peer ids are left out unless you add --include-network-ids.

Copy only the report body after reviewing it. Collection progress printed before the report can show your work directory's full path, including your user name. The report body can show a loopback address; peer IP addresses and peer ids are omitted by default.

• -m "stops syncing after an hour" says what happened without being asked.
• --no-browser prints the issue link instead of opening it, for a server: open the link on any machine. Without a terminal to confirm on, add --yes, or no link is printed and the report is only saved in bug-reports/.
• --output report.md only saves the report, and prints its full path.
• --log reads the log from elsewhere, for a node that logs to the journal:

A report too long for a link is saved in bug-reports/ in the work directory; attach that file to the issue.

The dashboard's Report a problem page makes the same report. Say what happened, press Prepare report, then copy it, download it or open the GitHub issue. Nothing is collected until you press the button, and nothing leaves the page until you copy, download or open it.

The dashboard's report skips the check of the saved chain state. For a node that logs to the journal, use mina report --log - as above.

After a recent crash, or a restart after one, the dashboard's overview says when it happened, with the first line of the panic and a link to the Report a problem page.