About the runtime log for IoT View

IoT View generates a runtime log provides details about the runtime status of your project.

Viewing the log messages

The runtime log that IoT View generates is equivalent to the log that is displayed in the Output window or LogWin tool for projects running in other runtime editions. There are some important differences, however.

The LogWin module is not supported by IoT View, so you cannot use it to remotely view the runtime log or save the log to a file. In fact, due to IoT View's tight integration with Mobile Access, the content of the runtime log is more like the Mobile Access activity log than it is like the log generated by the other AVEVA Edge runtime editions. It even uses the same log settings as Mobile Access. For more information, see "Changing the log settings in the project" below.

If the Remote Agent program is configured to automatically start as a service (daemon) when the target station is turned on, the log messages are saved to a file on the target station. By default, this file is located at /var/log/RemoteAgent.log

Alternatively, if you use the command line interface to manually run either Remote Agent or IoT View itself, the log messages are displayed as program output in the same shell or console that you used to run the program. The log messages are not normally saved, but you can redirect the program output to a file. For example:

$ RemoteAgent > /var/log/RemoteAgent.log

If you want to remotely view the log, use the Mobile Access web interface instead. For more information, see Use the browser console to view the Mobile Access activity log.

By default, the runtime log contains only critical issues like runtime errors and unsupported features used in the project. This is the "level 1", minimum verbosity for the log, and it should be just enough information to help you diagnose those critical issues. You can increase the verbosity and/or change the log settings so that the log provides more information, but keep in mind that you risk making the log so verbose that it consumes more drive space, affects your project's runtime performance, and makes it more difficult for you to find the information you actually need.

Increasing the log verbosity in the project runtime

You can increase the log verbosity in the project runtime itself, by manually running the IoT View program with some additional parameters:

$ iotview <project file path> <log verbosity 0–5>

For example, to view a "level 2" log in the shell or console:

$ iotview ./App/MyProject.app 2

Or to save a "level 4" log to a file:

$ iotview ./App/MyProject.app 4 > log.txt

Tip: If the Remote Agent program has already started as a service, you should stop it before you manually run the IoT View program.

This is useful when you do not have access to the project development environment and/or you only want to make quick, temporary changes on the target station for the purpose of troubleshooting. When you are done, you can stop the IoT View program (by pressing Ctrl+C in the shell or console) and then resume normal operations.

Please note that if you specify log verbosity 0, the runtime log will be disabled entirely. This is not recommended, because you might miss critical errors during run time.

Changing the log settings in the project

You can change the log settings in the project and then download the project again to the target station.

The log that is displayed in the shell or console is controlled by the log settings for the Output window in the project development environment. For more information, see Configure the log settings for the Output window. (Please note that only the Mobile Access/IoT View settings apply; none of the other settings are supported by IoT View.) These settings will provide additional information over and above the error log verbosity that has been specified for the project runtime itself. Even if you do not select any of these settings, the project runtime will still provide the "level 1", minimum verbosity error log as described above.

The log that can be viewed remotely using the Mobile Access web interface is controlled by the log settings in the Mobile Access Configuration worksheet. For more information, see Configure the global settings for all areas.

You can configure the two sets of log settings so that they match each other, but you do not need to. In fact, you will probably want to configure Mobile Access to show less information in its log because it can be viewed by any user in the browser console.