How to use Portainer to debug a Vizi-Ai application

Reading Time: 3 minutes

Head of Engineering and Architecture for ADLINK Technology

Your Vizi-Ai template profile comes with Portainer installed by default. You can find out more information about Portainer at www.portainer.io

ADLINK’s Edge Profile Builder has been built to integrate seamlessly with Portainer. This allows users to debug and control what is happen-ing within the Vizi Apps, without having to open a terminal window or SSH on to the physical device.

Once Portainer has been detected running on a registered device, the logo will show to the right of the device name. Selecting this logo will open Portainer.

Logging in to Portainer

The first time you login to Portainer you will be required to setup a password. Once you have entered a password for the admin user, con-firm that password and select Create user.

When first logging in to the Portainer environment the system asks for some configuration elements to be chosen. For Vizi-Ai we are rec-ommending users to select the Local deployment option. This enables Portainer to manage the docker environment on the local Vizi-Ai that it is installed on.

Once you have selected the Local option select Connect to initiate the Portainer connection to your Vizi-Ai.

Management of local applications

The Local management option will show you basic information about your Vizi-Ai. After your Vizi-Ai has powered on and all apps have started, it should look identical to the following image:

Selecting the Local tile provides a more granular view of the docker environment installed on your device. To begin debugging applica-tions, select the Containers tile on the page.

When your Vizi-Ai is deployed with the vizi-ai-starter-kit template profile, you will see eight applications running and one stopped, this is as designed. The aws-model-streamer application has stopped because the installed template profile does not have any configuration details for an AWS cloud connection, and therefore will not run.

Selecting a container will show additional information about the application that is running. 

In the example below, we’ve selected the Frame Streamer application. On this page you are presented with multiple options to debug any issues that may occur. Typically support teams start by viewing the Logs for an application to learn more about any potential issues.

Viewing application logs

When entering the Logs area you are presented with options at the top of the screen. These drive the behaviour of the log outputs be-low them. 

The option to Auto refresh logs will load additional log entries to the bottom of the screen once they are generated. Switching this op-tion off enables the log files to be static and slightly easier to search.

To restart a container, simply navigate to the screen below, select the container(s) and the action you want to take on those containers. 

Please note: Containers on our platform are designed to maintain a desired status for all applications and configurations. After stopping a container you will find that it will start it again automatically.

Stay in touch

Sign up to our email list to be notified of the latest industry news