Debug

Check Status

IOhubTM has its own system monitoring applications that shows how your device and applications run and perform.

The applications are already included in IOhubTM and is ready-to-use. IOhubTM system application does not require additional configuration.

The available applications can be categorized in:

  1. Resource monitoring

  2. Application troubleshooting

Please check "Choose an application from catalog" section on how to deploy the above applications within IOhubTM

System Monitoring

With the System Monitoring application you'll be able to check system resource usages such as CPU, Memory, Storage and many others.

How to deploy IOhub system monitoring

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name)

  1. Click Choose from Catalog button.
Choose from Catalog
  1. Click +Add button to add "IOhub System Monitoring (ezvpn-monitoring)".
<iohub></iohub> add system monitoring

The application has now been added. You need to configure the application so it will start at any IOhubTM restart.

<iohub></iohub> start monitoring

Leave Edit Mode to apply the configuration and IOhubTM will start the system monitoring application.

Access system monitoring

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name):

  1. Click Info button to show the System Monitoring links.
  2. Click the proper link to open the System Monitoring interface.
<iohub></iohub> info monitoring
<iohub></iohub> url monitoring
Please note, in the example above there are two different links because IOconTM service is enabled in the EZ BoxTM and configured in router mode. One link only will appear when just IOhubTM is enabled.

http: //192.168.178.21:12301/ this link uses the WAN IP address to access the monitoring interface.

http: //192.168.30.1:12301/ this link uses the LAN IP address to access the monitoring interface.

Clicking on the link to access the monitoring interface using your browser:

Monitoring interface

Please note that when the EZ BoxTM is configured in Router Mode, access from WAN interface must be set to UNLOCKED to access your application.

Troubleshoot your application

Sometimes, it may be necessary to check the logs of an application. IOhubTM has different tools that have been developed for this purpose.

Application debugging

IOhubTM developers can use a powerful debug interface to check if each container of the application run correctly. This interface is integrated in the IOhubTM management web site and shows the logs of each container part of the same application.

Each application a specific entry log in the debug interface. Debug interface is disabled by default for all applications configured in IOhubTM.

Debug interface require that both EZ BoxTM device and the operators have access to the internet. If for any reasons the EZ BoxTM device cannot access to the internet we recommend evaluating the Docker Logs (ezvpn-logger) for debugging.

Enable debug

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name)

  1. Click Enable Debug button for each application for which you require the debug logs.
  2. Click Leave Edit Mode to enable the Debug and restart the EZ BoxTM device.
<iohub></iohub> enable debug

Please note that when Debug Log is enabled a continuous data log flow is generated by the EZ BoxTM device. The amount of data generated may vary and it depends on the number of containers configured and the data collected by the device. This is generally a negligible amount of information while a wired internet connection is used but it should be considered with attention when a metered connection like the cellular network is preferred. Data flow stops automatically after 7 days or can be stopped manually by disabling the Debug Log.

Start debug

If debug has been enabled, the Debug Log section is shown in the the IOhubTM EZ BoxTM management interface.

  1. Click Start button to start log visualization.
<iohub></iohub> start debug
Please note, logs are in real-time from your EZ BoxTM device and will only be shown if the Start button has been clicked. Logs are not stored in the EZ VPNTM servers and logs generated prior to the click of the Start button will not be considered and will not be shown in the Debug Log interface.

When Start button is clicked and the EZ BoxTM device has access to internet the following message appears in the debug log interface:

<iohub></iohub> debug connected
Please note, when debug log has not been used for more than 7 days the debug session will expire. It will be enabled again when you will leave Edit mode.
<iohub></iohub> debug session expired

As soon as logs from the EZ BoxTM device are generated they'll appears in the debug log interface.

The user can scroll the Debug Log interface to show previous logged lines for a maximum of 1.000 buffered lines. Older excess lines will be automatically discarded.

Please note, that in case of browser session time-out or you leave Debug Log interface page the debug log interface is stopped and the previously collected logs will be lost.

Filter debug

  1. type a text in the Filter field to filter the acquisition of the log.
Logger interface

Please note that the applied filter is filtering the upstream acquisition. Removing the filter will not show the previously filtered content.

Each line of the log is structured in this way:
  • Application Name:

    This is the name of the application assigned in the IOhubTM management interface.

  • Container Name:

    This is the name of the docker container.

  • Log:

    This is content of the log.

<iohub></iohub> debug loading

MQTT debug

By default, Debug Log interface shows Docker container logs only. There are some cases where it is necessary to debug MQTT messages and watch data pass through the MQTT broker of your application.

The MQTT Logger is an IOhubTM container that has been developed for this purpose.

When the MQTT Logger is added in an IOhubTM application and the Debug Log is enabled, the MQTT messages passing through the MQTT Broker of your application will be shown in the Debug Log interface. This is useful to have a confirmation that data is regularly transferred within the application.

Add the MQTT Logger

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name):

  1. Click Manage button of the application to which you need to add the MQTT Logger container.
<iohub></iohub> manage mqtt logger
  1. Click Choose from Catalog button to enter IOhubTM catalog.
<iohub></iohub> manage mqtt logger catalog
  1. Click +Add button to add Debug MQTT Logger container
<iohub></iohub> add mqtt logger
  1. Click Back to EZ Box button to leave application management interface.
<iohub></iohub> add mqtt logger
  1. Click Leave Edit Mode button to save the configuration and restart the EZ BoxTM device.
<iohub></iohub> leave edit mode
  1. Click Staqrt button to start debug log visualization.
<iohub></iohub> debug connected

MQTT message flows, will be shown in the Debug Log interface like in the example below:

<iohub></iohub> debug connected

Disable debug

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name)

  1. Click Disable Debug button for each application for which you require to disable the debug.
<iohub></iohub> disable debug

How to deploy Docker Logs Viewer

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name):

  1. Click Choose from Catalog button.
Choose from Catalog
  1. Click +Add button to add "Docker Logs Viewer (ezvpn-logger)"
IOhub add docker logs viewer

The application has now been added. You need to configure the application so it will start at any IOhubTM restart.

<iohub></iohub> start monitoring

Leave Edit Mode to apply the configuration and IOhub will start the system monitoring application.

Access log viewer

From the IOhubTM EZ BoxTM management interface (IOhubTM/EZ BoxTM name):

  1. Click Info button to show the Log Viewer links.
  2. Click the proper link to open the Log Viewer interface.
<iohub></iohub> log viewer
<iohub></iohub> url log viewer
Please note that in the example above there are two different links because IOconTM service is enabled in the EZ BoxTM and configured in router mode. Only one link will appear when just IOhubTM is enabled or the EZ BoxTM device is configured in router mode.

http: //192.168.178.21:12301/ this link uses the WAN IP address to access the monitoring interface.

http: //192.168.30.1:12301/ this link uses the LAN IP address to access the monitoring interface.

Click the link to access the log viewer interface using your browser:

  1. Click the Start button to start log acquisition.
Logger interface
  1. type a text in the Filter field to filter the acquisition of the log.
Logger interface

Please note that the applied filter is filtering the upstream acquisition. Removing the filter will not show the previously filtered content.

  1. Click the Stop button to stop the log acquisition.
Logger interface

Please note that when EZ BoxTM is configured in Router Mode, access from WAN interface must be set to UNLOCKED to access your application.