Breeze log files and troubleshooting
This page describes log files and troubleshooting, sharing files with Prediktera support, and ways to troubleshoot performance issues.
About Breeze and Runtime log files
The log files contain time-stamped entries with information on what the application is doing. Entries have different levels such as Debug, Information, Warning, Error where Debug entries are the most detailed, while Errors are rare and a sign that something is wrong.
As an example, here is the Runtime log file from when it it started:
Log file location
The log files are located in the current user's home directory in the .Prediktera/Breeze folder.
In Windows this folder can be opened in File Explorer using %userprofile%\.Prediktera\Breeze
Log files are archived daily to the archives sub folder which contains the full history of earlier log files. If this folder becomes large you can manually delete files.
Breeze and Breeze Runtime log files
The desktop application Breeze uses two log file:
error.log- contains just warnings and errorsdebug.log- contains the warnings and errors, and also contains debug level entries which gives the full context
The Breeze Runtime is responsible for all data acquisition and calculations. It has its own log file:
BreezeRuntime.log- This log file is useful not only to troubleshoot Breeze, but also third party applications using the Runtime programmatically. See Introduction to Breeze Runtime development.
Advanced: changing Runtime log level
The Runtime log level can be changed to control the volume of events. You do this in the NLog.configfile located in the {program files}/Prediktera/Breeze/Runtime folder. The default settings in in the file are the following.
<rules>
<logger name="*" minlevel="Debug" writeTo="logfile" />
<logger name="*" minlevel="Info" writeTo="console" />
</rules>Learn more about configuration at the NLog project’s web site.
The Runtime log level can also be changed by starting the Runtime with a command line parameter as described in Developers reference guide under the heading Runtime Command Switches.
Sharing files with Prediktera support
Sharing log files
You can create a copy of all log files using the Export Log files command available in the menu in Breeze.
The resulting zip file with copies of all log files can be shared with support.
The zip files also includes a copy of the workspace settings file BreezeProperties.xml, but not any project data. Those has to be sent manually to support, as described next.
Sharing projects and data for troubleshooting
If you are having issues with a certain project and analysis tree, a specific model, some specific measurement, or a specific camera, you can be asked by Prediktera support to send copies of files from the Breeze PC.
To export data, open the project in Breeze, then select the Import / Export tab, and select Project to export the whole project with measurements, models and the analysis tree work flow. You can also export measurements on the Import / Export tab.
Export creates zip files that can be shared with support.
Other files that support might ask for is the Breezeproperties.xml file located in the workspace root folder. It contains all settings include for the cameras you use. This file is automatically included if you do Export Log files, as described above.
Advanced Runtime Diagnostics for performance troubleshooting
The Runtime has built in diagnostics that can help troubleshoot performance issues when executing a workflow in real-time with data for a camera. Such issues can occur because of too complicated workflows, too slow computer hardware, to slow network, or too large volumes of data.
Learn more in Diagnostics
Monitoring Breeze memory usage
Hyperspectral data used in Breeze can be very large, and workflows in Breeze can be complex and use many machine learning algorithms. To be able to handle large data, a PC needs lots of physical memory (RAM). Also see system requirements at Supported Hardware - Prediktera.
You can evaluate if memory is a cause for poor performance, by monitoring RAM usage on the PC of the Breeze processes and comparing to the amount of physical RAM on the PC. Monitor both the BreezeRuntime.exe and Breeze.exe processes. If the combined memory usage of these processes is is larger than the amount of physical memory, this in an indication that more RAM can help improve performance.
Example screenshot from Windows Task Manager, filtered to show details only for Breeze processes. In this case the total memory usage is below 2 GB which is very little.
Fast solid state disks (SSDs) improve Breeze performance
As noted in the system requirements, we recommend fast SSDs for optimal performance. One SSD for the Breeze workspace, and another for the Windows installation.