1. Introduction

GBS SmartSense is a web app for monitoring GBDS clusters, allowing the user to view live reports on the environment’s health and performance.

This manual is updated for SmartSense version 1.0.0

1.1. Access and Authentication

GBS SmartSense should be accessed with a web browser, and Google Chrome is recommended. The URL for access is specific to each deployment. If necessary, contact Griaule’s support team to obtain the correct URL.

Authentication is required to access the application. The credentials required by GBS SmartSense are username and password.

login screen

2. User Interface

There are four screens that can be accessed using the sidebar: Node List, Configuration Comparison, Port Sweep, and Transaction History.


2.1. Node List

The Node List screen displays information on available storage space, RAM, temperature, number of matchers and status for each host/IP.

nodes list screen

To refresh the displayed information, use the refresh button or reload the whole page pressing Ctrl/Command + R on the keyboard.

refresh button

On the upper-right corner, it is possible to filter the displayed information by hostname or IP address:

nodes filtered list

To create a new node without accessing the database directly, click on the New Node button on the lower-right corner. Enter the hostname, IP, and port. Then, check the box if it’s an Active node. Finally, click on Add Node.

The Active status means that the node will be analyzed and displayed on SmartSense.

new node popup


The hostname identifies the node, so it must be unique. Attempting to create a new node with the same hostname of an existing one will overwrite the existing node.

2.1.1. Node Details

Click on an item of the Node List to open the Node Details screen, which displays detailed information about the services running on that node (Services tab) and its hardware resources (Resources tab). In both tabs, it’s possible to refresh the information displayed by clicking on the refresh button located on the upper-right corner of the screen. Services Tab

The Services tab shows the services running on the node, their respective ports and their status.

node details service tab Resources Tab

The Resources tab shows some hardware information of the node, such as disk usage, RAM usage, transmission rate, etc.

node details resource tab

2.2. Configuration Comparison

The Configuration Comparison screen allows the user to select a configuration file and a reference node to compare its configuration with all other nodes. The different configurations are shown in red.

configuration comparison screen

To select a configuration file, click on the dropdown menu and choose a file from the list.

configuration comparison file selection

Then, to select a node, click on the dropdown menu and choose a node from the list.

configuration comparison node selection

It is possible to remove rows from the list by clicking on the X at the left end of the row. This option will only hide the row from view, it will not affect any file.

configuration comparison delete row option

To restore the original list with all the rows, check the box Show all rows.

configuration comparison restore all rows option

It is possible to filter the results and only show the columns with nodes that have a different configuration. To do that, check the box Only show nodes with differences.

2.3. Port Sweep

The Port Sweep screen allows the user to select an IP and specific ports to then perform a port sweep across all hosts and display the results on a table.

port sweep screen

To select an IP, click on the dropdown menu and choose an IP address.

port sweep IP list

The ports can be selected as a list of individual ports separated by commas (e.g., 8000, 8080, 8125); as a range, with the upper and lower bounds separated by a dash (e.g., 8005-8015); or as a combination of both (e.g., 8005-8015, 8080).

port sweep ports input field

After selecting an IP and ports, click on the Filter button, located on the upper-right corner of the screen to perform the port sweep.

2.4. Transaction History

The Transaction History screen shows usage histogram charts powered by Kibana. There are five tabs: Identify, Identify (Latent), Verify, Enroll, and Update. On each tab, it is possible to interact with the graph, for example, hover over a bar to show the number of operations or click and drag over some of the bars to zoom in. On the upper side of the chart, it is possible to add filters to customize the way the information is displayed.

transaction history screen


For this feature, it is necessary to have ELK installed and properly configured. Also, it is needed to have the following parameters in config.properties:

linkVerify=<link to Kibana dashboard>
linkIdentify=<link to Kibana dashboard>
linkIdentifyLatent=<link to Kibana dashboard>
linkEnroll=<link to Kibana dashboard>
linkUpdate=<link to Kibana dashboard>