Logs & Crash Reports

·

When something goes wrong, two kinds of file help: a log, which records what the app was doing step by step, and a crash dump, which Vertexix writes by itself if it crashes. Both live in folders next to the program.

Turning on logging

Logging is off by default. Turn it on from the View menu with Create Log; the menu item shows a checkmark while a log is being written, and clicking it again stops logging. The log goes to logs/vertexix_<timestamp>.log next to the executable.

The log is flushed to disk after every line, so it survives a crash — but it also slows the app down a little. Turn it on when you are about to reproduce a problem, not all the time.

To log from the very first moment (for a problem during loading, say), start Vertexix with the --create-log command-line option. See the Command-Line Options appendix.

Only the newest five logs are kept: older ones are deleted when Vertexix starts and whenever a new log starts. Change the number — or set it to 0 to keep every log — with Log files to keep in Settings > Miscellaneous Settings. Copy a log somewhere else if you want to keep it for longer.

View menu itemWhat it does
Create LogStarts or stops writing a log to the logs folder.
Open Log FolderOpens the logs folder in Explorer (creating it if logging has never been used).
Open ConsoleOpens a console window alongside the app.

Crash dumps

If Vertexix crashes, it writes a crash dump before it closes: a .dmp file and a matching .txt file in a crashes folder next to the program, both named vertexix_<date>_<time>. The text file records which build crashed, why, and whether the dump itself was written successfully. You do not need to turn anything on; the handler is installed as the app starts.

Reporting a problem

Help › Report Issue opens the issue tracker in your browser. A useful report includes:

  • The steps that lead to the problem, as precisely as you can.
  • A log of those steps (turn on Create Log first, then reproduce it).
  • The .dmp and .txt pair from the crashes folder, if it crashed.
  • The version, from Settings › About.
  • The model, or a smaller one that shows the same problem, if you can share it.