Gathering Diagnostic Logs and Crash Dumps

Heads up: This article was migrated from the PeakHour 5 documentation and may contain outdated screenshots or content. We're working through updates for PeakHour 6.

If you’re experiencing crashes or hangs, these steps will allow you to gather the crash dumps and logs for analysis.

Capturing Logs

1. Open Terminal.

2. Run the following command:
   log collect \
--predicate ‘eventMessage CONTAINS[c] "peakhour"' \
--last 12h \
--output ~/Desktop/PeakHourLogs.logarchive
   Change the ‘last’ argument to capture the time period in question (e.g. ‘30m’ for the last 30 minutes, ‘2d’ for the last 2 days etc.)

3. Send the file PeakHourLogs.logarchive as directed.

Capturing SNMP / UPnP Debug Logs

1. Quit PeakHour

2. Open Terminal.

   1. To enable SNMP debug logging, run the following command:
      defaults write com.digitician.peakhour5 EnableSNMPDebugLogging -bool YES

   2. To enable UPnP debug logging, run the following command:
      defaults write com.digitician.peakhour5 EnableUPnPDebugLogging -bool YES

3. Run the following command to enable writing debug log events to disk:
   sudo log config --mode "level:debug,persist:debug" --subsystem com.digitician.peakhour5

4. Start PeakHour and reproduce the issue.

5. When the issue has been reproduced, run the following command in Terminal:
   log collect --predicate 'subsystem BEGINSWITH "com.digitician.peakhour" AND (category == "upnp" OR category == "snmp")' \
--last 12h \
--output ~/Desktop/PeakHourLogs.logarchive

6. Run the following command to disable debug log writing:
   sudo log config --mode "level:default,persist:default" --subsystem com.digitician.peakhour5

7. Send the file PeakHourLogs.logarchive as directed.

8. To disable SNMP / UPnP debug logging, run the following commands:
   defaults delete com.digitician.peakhour5 EnableSNMPDebugLogging
defaults delete com.digitician.peakhour5 EnableUPNPDebugLogging

Capturing Logs (manual method)

1. Click the Spotlight (magnifying glass) icon in the top-right corner of the screen.

2. Type ‘Console’ - when you see the Console app highlighted, tap Enter.

   

3. If the Sources view is not visible down the left-side, choose View > Show Sources.

4. In the Sources view, choose the top most source under Devices. It will be called the same name as your Mac.

   

5. In the search field, type peakhour and press Enter.

   

6. In the Action menu, ensure Include Info Messages and Include Debug Messages are enabled.

   

7. Click Start Streaming to start gathering logs.

8. Reproduce the problem / issue you’re having.

9. Once the problem is reproduced, go back to Console.

10. Choose Edit > Select All then Edit > Copy.

11. Save the contents of the clipboard to a file, attach into an email.
    DO NOT paste directly into a message, as long messages can crash some email clients.

12. Send the log file to support, as directed.

Sending Crash Dumps

1. Click the Spotlight (magnifying glass) icon in the top-right corner of the screen.

2. Type ‘Console’ - when you see the Console app highlighted, tap Enter.

   

3. If the Sources view is not visible down the left-side, choose View > Show Sources.

4. In the Sources view, choose Crash Reports.

   

5. Locate reports related to PeakHour. 

6. Choose one and choose Reveal in Finder.

7. Right-click the file in Finder and choose Share > Mail or drop as an attachment in your email client and send to [email protected].