Configuring Widgets for GridGain 9 Clusters

Overview

You can add widgets of the following types in any of the Dashboard tabs except for My Cluster:

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
Heat map — the selected metrics as a heat map

Once a widget is added, you can edit its parameters - see Editing Widgets.

Adding Widgets

The Gauge widget displays the 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.

To add the Gauge chart widget:

Click Add widget.
From the list that opens, select Gauge chart.

The Select metric dialog opens.
Select a node and a metric.
Click OK.

The Nodes widget is a table that contains information about cluster nodes.

The following information is available in the Nodes widget:

Column Description

Column	Description
Name	The name of the node.
Node ID	The ID of the node.
Address	The `host:port` address of the node.

Name

The name of the node.

Node ID

The ID of the node.

Address

The host:port address of the node.

To add the Nodes widget:

Click Add widget.
From the list that opens, select Nodes.

You can show or hide columns in the Nodes list:

Click the ⋮ icon at the end of the row and select Table columns.
In the list that opens, select or clear check boxes to show or hide columns.

Metrics Widgets

There are three types of widgets: single value, chart, and table. A table and chart can display multiple metrics.

To add a widget to a tab:

Click Add widget.
From the list that opens, select Metrics (chart), Metrics (table), or Single value.

The Select metric dialog opens.
If the widget type you chose is Single value, select a node and a metric.
If the widget type you chose is Metrics (chart) or Metrics (table):
1. On the Basic view tab of the dialog, select a metric.
2. Optionally, to add multiple metrics to the chart or table, open the Advanced view tab and use the Add metric button for each new metric.
Click OK.

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 server nodes in the cluster, 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 shows the latest values for selected metrics.

For node metrics, the first column displays each node’s name and subsequent columns show metrics values. You can add any number of metrics.

You can toggle between metrics layouts by clicking ⋮ and selecting from View options.

By default, the widget uses a node-per-row view: each row shows a node or a cluster name followed by its selected metric values. This layout is useful for monitoring a few metrics across a large number of nodes.

When you need to track many metrics on a few nodes, switch to the node-per-column view. In this layout, columns are added dynamically as metrics arrive.

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.

To add the Heat map widget:

Click Add widget.
From the list that opens, select Heat map.

The Select metric dialog opens.
Select a metric to display.
Click OK.

The SQL query widget shows the results of the SQL query you define and updates these results with the specified frequency.

To add the widget:

From the Add a widget menu, select SQL query.

The Edit widget dialog opens.
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 FROM and LIMIT values 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.

This widget shows the selected system view table and updates that table with the specified frequency.

To add the widget:

From the Add a widget menu, select System view.

The Edit widget dialog opens to the System view tab.
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.

Editing Widgets

To change the name of a widget:

Click the "pencil" icon in the widget’s tile.
In the field that appears, edit the name as required.
Click the "check mark" icon.

Editing Gauge and Heat Map Widgets

To edit a gauge or heat map widget:

Open the widget’s context menu.
To change the static Min and/or Max value(s):
1. Make sure the selector to the right of the Min and/or Max field(s) is on "value" (rather than "metric").
2. Edit the value(s) in the Min and/or Max field(s).
To define the Min and/or Max value(s) dynamically, as the current value(s) of another metric(s):
1. Switch the selector to the right of the Min and/or Max field(s) from "value" to "metric".
2. In the Select metric dialog that opens, select the metric whose current value will serve as the Min or Max value of the metic the widget displays.
To show the current value of the metric in the widget (in addition to graphic/color representation), toggle on Show percentage.
To invert the color scheme (by default, red is for "high" and green is for "low"), toggle on Invert color scheme.
To select another metric to be displayed in the widget, select Select metric, then proceed as you would when adding a new widget.

Editing SQL Query and System View Widgets

To edit the SQL Query or System View widget:

Open the widget’s context menu.
Select Table columns to add or remove columns.
Toggle on or off Show info to show or hide the widget settings: the row number limit and the last update timestamp (on by default).
Toggle on or off Show search to show or hide the search bar across the top of the widget.
Select Edit widget to display the Edit widget dialog.

Editing All Other Widgets

To edit all other widgets (except gauge and heat map):

Open the widget’s context menu.
For Chart widgets, to show the widget’s legend (included metrics and their colors), toggle on Show legend.
To select another metric(s) to be displayed in the widget, select Select metric(s), then proceed as you would when adding a new widget.

Expanding Widgets

To select a widget’s display (normal vs expanded):

Open the widget’s context menu.
To make the widget display in a separate window (in a larger size), select Expand.
To return to the initial "tile" display, select Close.

Removing Widgets

To remove a widget from the dashboard:

Open the widget’s context menu.
Select Remove.

© 2025 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.

Last updated on May 29, 2025