There are five (5) main sections of the Clustrix GUI. Each of these can be directly accessed via the icons at the top of each page:

  1. Health Dashboard - View all important Cluster attributes at a glance
  2. Queries - View Current and Recent Queries
  3. Graphs - View all available Cluster attributes over time
  4. Compare - Compare Cluster attributes at different points in time
  5. Flex - Add or Remove nodes from the Cluster

Accessing ClustrixGUI 

Access the ClustrixGUI by typing the ip or hostname of one of your nodes into a web browser. For non-root installations, include port 8080. Chrome is recommended. 

When logging in for the first time, provide the following temporary credentials:

Clustrix strongly recommends that you create a new user and delete the [email protected] user. To create a new user, access the "Manage Users" in the upper right corner of any page by clicking on . For more information see Managing ClustrixGUI Users

Health Dashboard

The 'Health Dashboard' is designed to give a quick high-level overview of database cluster health and activity. There are 24-hour sparkline graphs of each of the five main cluster attributes: Transactions per second, CPU utilization, In-memory table utilization, Storage, and Read and Write latencies. These graphs are shown in green, yellow, or red depending on how they compare to threshold levels. Alerts are displayed for attributes which are 'too high'. 

All data is polled and updated every 5 seconds. Note: the 'big graph' showing 24 hours of data is displayed in 5-minute intervals. 

The 'Health' Icon will pulse red if any of the 5 main cluster attributes has exceeded the Alert thresholds.

Health Dashboard Tabs

TPS

The TPS section displays the number of database transactions-per-second across all nodes, including sections for:

CPU

The CPU section: displays Average CPU utilization across all the database nodes in the cluster including:

In Memory Table Utilization

The memory section highlights how memory is being utilized for In-Memory tables.

Storage

The Storage section displays how storage is being consumed across the active nodes in the cluster, including the following: 

This section also includes a breakdown of "Storage by node" and displays the "Storage allocation in the last 24 hours." These are useful for identifying uneven or "lumpy" distributions in data or recent changes to storage. 

 

Latency

 

Queries

The Queries tab has two distinct views that show Current and Recent Queries.

Current Queries

The Current Queries view displays all currently executing queries and queries that have completed within the last second. By default, this view is auto-refreshed every 5 seconds but can also be paused. If you navigate away from the Current Queries view, auto-refresh will resume. 

The following metrics are displayed:

Current Queries can be filtered via the Query Filters in the left pane or by entering text into the 'Filter by text' field. 

Queries shown in the 'Current' Queries view will be removed as they complete, and subsequently can be found on the 'Recent' page.

Recent

The 'Recent' Queries view displays all the queries which have been recently completed, along with the following metrics:

 

Recent Queries can be filtered via the Query Filters in the left pane or by entering text into the 'Filter by text' field. 

Graphs

The 'Graphs' tab displays important database attributes over a user-specified interval. The default interval is 24 hours, but can be range from 15 minutes to 7 days. Choose an interval width on the top ruler (using the left/right cursors), then drag that selected interval across the date range.  Refresh the screen to go back to the default time frame.

There are multiple Categories of graphs, including: Performance, Diagnostic, Queries and Rows, Locks, Sessions and Transactions, Replication, and Disk. Click on the desired category to expand graphs. The graph below views TPS, Read/Write Latency, CPU Utilitzation, and Network Latency.

 

Compare

The Compare tab allows users to compare two sets of database attributes at two different points in time. The default attributes are CPU min/max/average, and query latency.  The other attributes are shown in the drop-down below.

The left-side list of values is displayed on the left-side Y-axis, and the right-side list of values is displayed on the right-side Y-axis. The horizontal axis (time) is displayed and adjusted via the Rulers at the top of the page

Flex

The Flex page displays all the nodes and node statuses of the current cluster. It also allows the cluster to be expanded and reduced in size. 

ClustrixGUI includes an option to "Drop this node", which simply marks the node as softfailed. For additional instructions on modifying your cluster size, see Expanding Your Cluster's Capacity - Flex Up and Reducing Your Cluster's Capacity - Flex Down.