Configuring Widgets
Adding Widgets
To add a widget, select a tab in the Tab bar and click Add widget. You can add any of several types of widgets:
-
Gauge chart - the selected metrics as a gauge
-
Nodes — a table containing information about cluster nodes
-
Metrics (single value) - the current value of the selected metric
-
Metrics (chart) — the selected metric as a time series
-
Metrics (table) — multiple metrics in tabular form
-
Metrics (histogram) — the selected metric as a histogram
-
Heat map — the selected metrics as a heat map
-
Rebalance — the progress of an ongoing rebalancing process
-
SQL query - the results of an SQL query, updated at a specified frequency (
SELECTonly) -
System view - the selected system view table, updated at a specified frequency
-
DR receiver widgets
-
DR sender widgets
Renaming Widgets
You can use the widget menu to change the name a widget.
Widget Types
Gauge Widget
The Gauge widget displays a selected metric in a gauge from 0 to 100. You can view how close the value is to its expected maximum, for example, for CPU load.
Nodes Widget
The Nodes widget is a table that contains information about cluster nodes.
You can add and remove columns from the table via the widget’s menu.
To open the widget’s menu, click the ⋮ icon in the top-right corner of the widget.
The following information is available in the Nodes widget:
| Column | Description |
|---|---|
Order |
The order of the node. |
Node ID |
The ID of the node. |
Consistent ID |
The consistent ID of the node. |
Name |
The name of the cluster. |
Status |
Whether the node is online or offline:
|
Type |
The type of node: Coordinator, Server, or Client. |
Version |
The version of GridGain/Apache Ignite that was used to launch the node. If you are using the Rolling Upgrades feature that is available in GridGain Enterprise Edition, one cluster might have nodes with different versions. |
IP |
The IP address of the machine where the node is running. |
JVM PID |
The PID of the JVM. |
Mac |
The MAC address of the node. |
You can inspect the configuration of any node that is listed in the table.
Click the ⋮ icon at the end of the row and select Inspect Configuration.
Metrics Widgets
There are four types of widgets. Each type displays metrics in a particular form: value, chart, table, or histogram. A table can display multiple metrics. A value, chart, and histogram can display only one metric.
Metrics are grouped by scope. The term “scope” refers to whether the metrics provide information about the cluster as a whole, about a single node, or about a cache:
-
Cluster metrics display information about the cluster as a whole. For example, the number of nodes in the cluster.
-
Node metrics are specific to a node. For example, the amount of heap or the storage size on the node. The widget where the “Node” scope is selected contains the information for all cluster nodes.
-
Cache metrics are specific to a cache. For example, the size of the cache. The widget where the “Cache” scope is selected contains the information about all caches.
To add a widget to a tab:
-
In the tab and click Add widget.
-
In the widget, click the
⋮icon. -
From the menu that opens, select the scope.
-
Type the name of the metric you want to display.
By default, the Metrics widgets are updated every 5 seconds.
Metrics (single value)
The Single value widget displays the current value of the selected metric, such as the number of caches, the query running time, etc.
Metrics (chart)
The Metrics (chart) widget displays the specified numeric metric as a chart, at 5-second granularity. The data is displayed for the period that is selected in the Time Period control (located in the Tab bar).
Metrics (table)
The Metrics (table) widget displays a table that details the last values of multiple metrics.
For node metrics, the first column of the table displays the consistent ID of the nodes. For cache metrics, the first column is the name of the caches. Other columns contain the values of the selected metrics. You can add as many metrics as you want.
Metrics (histogram)
The Metrics (histogram) widget displays histogram metrics. The widget can display only metrics that return data structures that can be represented in a histogram. The parameters of the histogram (such as the bucket size) can be changed in the cluster configuration.
Heat Map Widget
The Heat Map widget displays a selected metric in temperature-related colors. Smaller values are displayed in a "colder" color, and larger values are displayed in a "hotter" color.
You can configure the values that are treated as minimum and maximum in the widget menu.
Rebalance Widget
The Rebalance widget displays the progress of the rebalancing process. When rebalancing is in progress, the widget displays the percentage of data that has been rebalanced.
You can use the rebalance widget to monitor Rolling Upgrades.
To display the versions of the nodes, click the widget configuration icon ⋮ and select Show Versions.
SQL Query Widget
The SQL query widget shows the results of the SQL query you define and updates these results with the specified frequency.
To display the widget:
-
From the Add a widget menu, select SQL query.
The Edit widget dialog opens.
-
Click Select a node and select a node for the query in the dialog that opens. If you don’t select a specific node, the widget runs on the coordinator node of the cluster.
-
From the Limit rows drop-down list, select the maximum number of rows for the query to return.
-
From the Update interval drop-down list, select an interval for the query to run.
-
If you want your query to run on a system view table, on the System view tab, from the System view table drop-down list, select the required system view.
-
On the Query tab, enter the required SQL expression. Note that
FROMandLIMITvalues are automatically populated based on your selections in steps 3 and 5. -
Click OK.
The widget displays as you have defined it and starts updating at the specified interval.
You can modify the way the information is shown in the widget using the options in its context menu:
-
Table columns - add or remove columns
-
Show info - toggle on or off to show or hide the widget settings: the row number limit and the last update timestamp (on by default)
-
Show search - toggle on or off to show or hide the search bar across the top of the widget (off by default)
-
Edit widget - display the Edit widget dialog
-
Expand/Close - expand the widget to the entire screen or collapse it to the default size
-
Remove - remove the widget
System View Widget
This widget shows the selected system view table and updates that table with the specified frequency.
To display the widget:
-
From the Add a widget menu, select System view.
The Edit widget dialog opens to the System view tab.
-
Click Select a node and select a node for the query in the dialog that opens. If you don’t select a specific node, the widget runs on the coordinator node of the cluster.
-
From the Limit rows drop-down list, select the maximum number of rows to return.
-
From the Update interval drop-down list, select an interval for the query to run.
-
From the System view table drop-down list, select the required system view.
-
Click OK.
The widget displays as you have defined it and starts updating at the specified interval.
You can modify the way the information is shown in the widget using the options in its context menu:
-
Table columns - add or remove columns
-
Show info - toggle on or off to show or hide the widget settings: the row number limit and the last update timestamp (on by default)
-
Show search - toggle on or off to show or hide the search bar across the top of the widget (off by default)
-
Edit widget - display the Edit widget dialog
-
Expand/Close - expand the widget to the entire screen or collapse it to the default size
-
Remove - remove the widget
© 2024 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.