GridGain Developers Hub

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

Gauge Chart Widget

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.

Gauge Widget

To add the Gauge chart widget:

  1. Click Add widget.

  2. From the list that opens, select Gauge chart.

    The Select metric dialog opens.

    Select metric

  3. Select a node and a metric.

  4. Click OK.

Nodes Widget

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

Nodes widget

The following information is available in the Nodes widget:

Column Description

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:

  1. Click Add widget.

  2. From the list that opens, select Nodes.

You can show or hide columns in the Nodes list:

  1. Click the ⋮ icon at the end of the row and select Table columns.

  2. 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:

  1. Click Add widget.

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

    The Select metric dialog opens.

  3. If the widget type you chose is Single value, select a node and a metric.

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

      Advanced view

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

Single value

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

Chart

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. Other columns contain the values of the selected metrics. You can add as many metrics as you want.

Table

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.

Heat Map Widget

To add the Heat map widget:

  1. Click Add widget.

  2. From the list that opens, select Heat map.

    The Select metric dialog opens.

  3. Select a metric to display.

  4. Click OK.

Editing Widgets

Changing Widget Name

To change the name of a widget:

  1. Click the "pencil" icon in the widget’s tile.

  2. In the field that appears, edit the name as required.

  3. Click the "check mark" icon.

Editing Gauge and Heat Map Widgets

To edit a gauge or heat map widget:

  1. Open the widget’s context menu.

    Edit Gauge or Heat Map

  2. 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).

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

  4. To show the current value of the metric in the widget (in addition to graphic/color representation), toggle on Show percentage.

  5. To invert the color scheme (by default, red is for "high" and green is for "low"), toggle on Invert color scheme.

  6. To select another metric to be displayed in the widget, select Select metric, then proceed as you would when adding a new widget.

Editing All Other Widgets

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

  1. Open the widget’s context menu.

    Edit Chart

  2. For Chart widgets, to show the widget’s legend (included metrics and their colors), toggle on Show legend.

  3. 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):

  1. Open the widget’s context menu.

  2. To make the widget display in a separate window (in a larger size), select Expand.

  3. To return to the initial "tile" display, select Close.

Removing Widgets

To remove a widget from the dashboard:

  1. Open the widget’s context menu.

  2. 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 Apr 02, 2025