Ctrlk
Planner Login
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Collecting Hamina Onsite Logs

While very rare, we might need you to collect some logs from Hamina Onsite to troubleshoot connection or site survey issues.

Collecting Logs

When collecting logs from an iOS device, note:

  • Connect the iOS device to a Mac with cable and keep the screen unlocked.

  • Ensure the iOS device name doesn’t include special characters because it can cause the log collection to fail. For example “Jussi´s iPhone” → “Jussis iPhone”.

  • The device name can be changed from Settings → General → About → Name

  1. Open the terminal on Mac and switch to the folder where you want to store the log file. E.g:

    cd ~/Downloads

  2. Collect the log file named `onsite_log.logarchive in the folder:

    sudo log collect --device-name "Jussi iPhone" --start "2024-02-06 11:45:00"  --output onsite_log.logarchive

  • -device-name must match your device’s name.

    • It’s only required when collecting logs from an iOS device. The logs are collected default from MacOS.

  • -start specifies from what time the logs are collected.

    • The logs can be multiple gigabytes if collected over multiple days so it’s better to specify the time just before the issue happened.

    • The date format might depend on the OS. Run the command sudo log collect --help to see all the available options and the date format.

  • -output specifies the log file name.

Converting Logs to a Smaller Text File

The log collection command doesn’t have an end date filter, and the logs contain a lot of other apps and OS log messages that we are not interested in. The logs can be filtered on the command line with the log show command to include only Onsite logs in a specific time interval:

This will create a text file onsite_log.txt that contains only the Onsite app logs.

The date format might differ in different operating systems. Use the command log show --help to check the date format.

Change the argument --process 'Hamina Onsite' to --process 'Hamina Onsite Test if the log archive is from the Test app.

Last updated