User Guide

Configuration

In just a few steps it is possible to configure an Alyvix node in NetEye in order to monitor it from the web interface.

Nodes

Create an Alyvix node

To begin monitoring an Alyvix node, the node must first be created in the Director module as an Icinga Host, setting at least one Hostname and one Host address, see Fig. 230.

Moreover also select Yes in the Alyvix node field under the Alyvix settings section.

Creation of a Host as a Alyvix node

Fig. 230 Creation of a Host as an Alyvix node

Once all the settings have been configured, a deployment is needed.

Visualize nodes

The Alyvix node list can be visualized by visiting the Alyvix / Nodes page. The following fields are displayed for each node:

  • Name: The name of the Alyvix node set previously during the Host creation

  • Sessions status: The list of sessions with the status. Possible status values are:

    • disconnect_icon Disconnected

    • running_icon Running

    • waiting_icon Connected

    • stopped_icon Connected but with the control session in Stop or Break

  • Health: The Host status monitored by NetEye. Next to the health status is a link that opens the host page in the monitoring module.

  • License: The status of the license can be: Disabled, Active, Expiring or Expired

  • Alyvix version: The version of Alyvix that is running on the node

Apart from the node details, a summary provides the following information:

  • Total nodes: The overall number of nodes

  • License alerts: The number of licenses that are not in the Active status

  • Health alerts: The number of nodes with the host status DOWN or UNREACHABLE

For an easier lookup of the relevant information related to the nodes and their execution, it is possible to search the table, by using the search bar, and sort the various columns, clicking their name.

The Alyvix nodes page

Fig. 231 The Alyvix nodes page

Manage node details

From the nodes page, available at Alyvix / Nodes, it is possible to click a particular node in the list to visualize its details. The details panel, shown in Fig. 232, is then rendered on the right-hand side of the table, displaying the details of the node, grouped in three different tabs.

Sessions Tab

A session on an Alyvix node is defined by the following properties:

  • Name: The domain and the session username separated by a \ . E.g. WP\MyUsername

  • Testcase waiting period: Number of minutes before scheduling the next test case

  • Workflow waiting period: Number of minutes before restarting the workflow

  • Display dimensions

    • Width: the width of the screen resolution in pixels

    • Height: the height of the screen resolution in pixels

    • Zoom: the zoom percentage

  • Password: the password used by the session in conjunction with the username

The Sessions tab, shown in Fig. 232, contains:

  • The New session button, which allows a user to create a new session

  • A counter, that reports how many licensed sessions have been consumed out of the available ones

  • The sessions table, in which each row represents a separate session defined on the node. Each session on the node can be edited or deleted by selecting the preferrable action in the More options menu for a particular session. When editing a session a user can:

    • Modify the sessions properties in the Settings tab. Please note that the Name cannot be changed

    • Manage the session workflow in the Workflow tab

    A change in the session workflow status can also be applied to multiple sessions, by selecting the corresponding rows in the tab and applying the desired action.

The session list of a node

Fig. 232 The session list of a node

Session workflow

Fig. 233 Session workflow

Control multiple sessions workflow

Fig. 234 Control multiple sessions workflow

License Tab

In this tab the following details about the node license are reported:

  • Status: the status of the license

  • Subscription plan: the subscription plan currently in use

  • Expiration date: the expiration date of the license

  • Remaining days: days left before license expiration

  • Licensed sessions: the number of sessions available with the subscription plan currently in use

Moreover, the tab offers the possibility to download the request key, necessary to obtain a new activation key for the selected node. Once the request key has been downloaded, please contact your Alyvix provider in order to obtain the activation key, which can then be uploaded directly from the node’s License tab.

General Settings Tab

The General Settings tab reports the private key for the selected node and the retention period, in hours, for the successful test cases, failed test cases and for the service logs. You can also edit settings in the General tab.

Test Cases

Manage Test Cases

The Alyvix test cases list can be visualized by visiting the Alyvix / Test Cases page. The table displayed in the page provides a user with an overview of the test cases scheduled on all Alyvix nodes, useful to centralize, in a single view, the information coming from different nodes.

For each test case, the following data about its execution are displayed:

  • Name: The name of the test cases

  • Node: The name of the node on which the test case is scheduled

  • File: The name of the file associated with the test case

  • Arguments: The arguments used by the test case during its execution

For an easier lookup of the relevant information related to the test cases and their execution, it is possible to search the table, by using the search bar, and sort the various columns, clicking their name.

The Alyvix test cases page

Fig. 235 The Alyvix test cases page

Moreover, a dedicated option of the More options menu allows a user to delete, after confirmation, a selected test case.

Furthermore, when visualizing the test cases, it is possible to add a test case by clicking the Create button. A side panel will open with the possibility to schedule a test case on one of the available nodes.

Manage Test Cases details

You can view the details of a particular test case by clicking it in the test cases list. The details panel for a selected test case will appear on the right, with details being grouped into Sessions and General tabs.

Sessions Tab

This tab reports all sessions a test case is scheduled for. Each session can be identified by its name and the status of a test case in the session, either enabled or disabled. The status can be simply changed by using the associated checkbox.

On the other hand, a session’s workflow and settings can be modified by clicking the arrow button for a particular session item.

The Alyvix test cases sessions details

Fig. 236 The session details of a test case

General Tab

General test case details include:

  • Name: The name of a test case

  • Node: The node a test case is scheduled for

  • File: The file containing the test case definition, selectable among the files available on the node

  • Arguments: The arguments used by a test case during its execution

  • Compression: The compression status of the screenshots taken by a test case (compressed or lossless)

When visualizing the general details of a test case, it is possible to update the file, arguments and compression parameters.

The Alyvix test cases general details

Fig. 237 The general details of a test case