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:
- Health Dashboard - View all important cluster attributes at a glance
- Queries - View Current and Recent Queries
- Graphs - View all available cluster attributes over time
- Compare - Compare cluster attributes at different points in time
- Flex - Add or remove nodes from the cluster
Access the ClustrixGUI by typing the IP or hostname of one of your nodes into a web browser. Chrome is recommended.
If you are logging in for the first time, provide the following temporary credentials:
- Email: firstname.lastname@example.org
- Password: clustrix
- Target: hostname or IP address of any node in your cluster
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 four main cluster attributes: Transactions per second, CPU utilization, Storage, and Read and Write latencies. These graphs are shown in green, yellow, or red depending on how they compare to threshold levels. Visual alerts are displayed for attributes that exceed the thresholds.
All data is polled and updated every 5 seconds. The graph showing 24 hours of data is displayed in 5 minute intervals.
The Health Icon will pulse red if any of the 4 main cluster attributes has exceeded the alert thresholds.
The sparkline graphs on each tab are autoscaled to improve visibility. The overall shape of the detailed sparkline will be similar to its corresponding 24-hour graph, but the 24-hour graphs are displayed without scaling.
Health Dashboard Tabs
The TPS section displays the number of database transactions per second (TPS) across all nodes, including sections for:
- Current transaction execution times
- Current transactions per second by node
- Transactions per second for the last 24 hours (5 minute intervals)
The CPU section displays average CPU utilization across all the database nodes in the cluster including:
- CPU usage breakdown
- Current CPU usage by node, which can be used to identify imbalances
- CPU usage over the last 24 hours
The Storage section displays how storage is being consumed across the active nodes in the cluster, including the following:
- User: Amount of user space
- Undo: Amount of undo log
- Replication: Amount of storage used by replication binlog(s)
- System: Amount of storage used by system processes
- Free: Amount of free space in the cluster
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.
This section shows cumulative query latencies over the last 24 hours by node.
The sparkline and 24-hour graphs each display two sets of data. In the lighter green displays read latency and darker green displays write latencies. The 24-hour graph displays read latency in the lighter blue and write latency in the darker blue.
The next two tables list current latency by node for reads and writes.
The Queries tab has two distinct views that show Current and Recent 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.
Current Queries can be filtered via the Query Filters in the left pane or by entering text into the "Filter by text" field.
The Recent Queries view displays all the queries that have been recently completed, along with the following metrics:
- Exec Count: The number of times the query was executed
- Avg Exec Time: The average amount of time each iteration of the query took to execute
- Query Statements: Displays the query statement, up to two lines. Click "Show More" to display the full query
- Avg Rows Read: The average amount of rows read by the associated query
- Database: The database on which the query executed
Recent Queries can be filtered via the Query Filters available in the left pane or by entering text into the "Filter by text" field.
The Graphs tab displays a variety of metrics over a user-specified interval. The default interval is 24 hours, but can range from 15 minutes to 7 days. Choose an interval width on the top ruler then drag that selected interval across the date range.
There are multiple categories of graphs including: Performance, Diagnostic, Queries and Rows, Locks, Sessions and Transactions, Replication, and Disk, each with a number of graphs available. Click on the desired category to expand its list of graphs. Click the +/- box on the right to expand or collapse all the graphs in a category.
- The graphs are aligned by time so that moving your mouse cursor over a graph creates a vertical "needle" to help correlate the attributes for each visible graph from that same time.
- Hold down the Mac Command key or Windows Start key and click with the mouse to place a static needle. Static needles help compare attributes with the attributes displayed by the moving needle controlled by your mouse.
- Static needles are very helpful in identifying inflection points across multiple graphs. For example, expand a graph, find a point of interest, and place a static needle. Then you can expand several different graphs to see if there is corresponding activity at that time-point across multiple different sets of attributes.
- Zoom in on a graph by selecting (click/dragging) the portion of the graph you want to view. You can zoom horizontally and vertically. Vertical zoom especially helps with exposing data that is near the floor of the graph, and/or has minor differences. Horizontal zooming helps quickly identify areas of interest from a 7-day view.
- Double-click the graph to reset the zoom level.
The Compare tab allows users to compare two sets of database attributes at two different points in time, with two different sets of attributes. The two points-in-time are selected by click/dragging each of the two black "needles" in the graph area. The graphed attributes are set with the pick-lists under the graph area, on the left and right.
The Y axis on the left side of the graph is set by the list of values on the left side of the page (default is CPU min/max/average). The Y axis on the right side of the graph is set by the list of values on the right side of the page (default is query latency). The horizontal axis (time) is displayed and adjusted via the rulers at the top of the page. The top ruler represents days and the lower ruler represents hours.
- When you click/drag the needles across the graph, the queries in the list below the graphs will automatically update to reflect the time period under that needle. Thus, the left query region displays query statements at the time selected by the left needle, and vice-versa for the right.
- Graph needles can be placed at any location on the timeline, and at any zoom-level, so it's possible to have placed a needle that isn't currently visible. Graph needles that aren't currently visible are displayed in grey at the side of the page, with an left or right triangle indicator.
- Graph needle indicators (highlighted in yellow) are on the top ruler.
- Double-clicking the top ruler automatically adjusts the viewing area centered on where you clicked, and defaults to 8 hours wide (visible in the second ruler).
- The following fields are included in the list of queries:
- Database: The database on which the query executed.
- Query Statements: Displays the query statement, up to two lines. Click "Show More" to display the full query.
- Rows Read: The amount of rows read by the associated query.
- Each of the Query Statement views can be filtered by entering text in the available query boxes.
The Flex page displays the nodes and their status in the cluster.
To add a node, please see ClustrixDB Installation Guide Bare OS Instructions. Then enter that node's IP and click Search to add it to the list of Available Nodes. Then click Add to add it to the cluster. See also Expanding Your Cluster's Capacity - Flex Up.
When searching for an IP, if the node is not available to be added, the result will be listed as "Unavailable", then be cleared within 10 seconds.