GridGain Developers Hub

Configuring Widgets for GridGain 9 Clusters

Adding Widgets

To add a widget, select a tab in the Tab bar and click Add widget.

You can add widgets of the following types:

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

Renaming Widgets

You can use the widget menu to change the name a widget.

Widget Types

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 caches, 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. 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.

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.