Skip to end of metadata
Go to start of metadata

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. Chrome is recommended.

If you are logging in for the first time, provide the following temporary credentials:

  • Email: noreply@clustrix.com 
  • Password: clustrix
  • Target: hostname or IP address of any node in your cluster

     

Clustrix strongly recommends that you create a new user and delete the noreply@clustrix.com user. To create a new user, access the "Manage Users" in the upper right corner of any page by clicking on .

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: Current transaction Execution times, Current transactions per second by node, and Transactions per second in the last 24 hours shown in 5 minute intervals. 

CPU

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

In Memory Table Utilization

The memory section highlights how memory is being utilized for In-Memory tables. The % of memory used represents the percentage 

Storage

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. 

Latency

  • "Latency over the last 24 hours": Displays the query read and write latencies (two-color chart) over the last 24 hours in  5 minute intervals
  • "Current latency by node (Read/Write)": Amount of read and write latency (read% above, write% below) for each node in the cluster, represented as percentage-latency per node

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. 

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

Icon

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:

  • Exec Count: The number of times the query was executed
  • Exec Time: The 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.
  • Rows Read: The 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 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.

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. 

  • Moving the cursor back and forth over a graph creates a vertical 'needle' which displays the attributes for each visible graph at that time-stamp. All the graphs are aligned by timestamp, to aid in point-in-time analysis.
  • Single-click to place a vertical 'needle' for comparison purposes with the (moving) needle under the mouse
  • Graphs can be zoomed-in by click/dragging vertically on a graph. Double-click the graph to reset the zoom level to normal
    • Be sure to drag vertically, or a little bit to the left, to zoom vertically

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 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

  • The queries occurring at the timestamp selected is displayed under the associated needle. Thus, the left-side 'Query Statements' occurred at the point-in-time where the left needle is currently placed
  • The following fields are displayed in the two Query Statement views:
    • 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 via partial-entry text in its associated 'Filter Queries' box

Flex

The Flex page displays all the nodes and node statuses of the current cluster and allows the cluster to be expanded and reduced in size. See Expanding Your Cluster's Capacity - Flex Up and Reducing Your Cluster's Capacity - Flex Down.

Icon

ClustrixGUI includes an option to "Drop this node", which simply marks the node as softfailed. For additional instructions on removing nodes from your cluster, please refer to the link above for Reducing Your Cluster's Capacity.

 

 

  • No labels