GridGain Developers Hub

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:

  • Nodes — a table containing information about cluster nodes.

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

Renaming Widgets

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

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.

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

Online

Whether the node is online or offline:

  • "Online" — the node is up and connected to the cluster.

  • "Offline" — the node is registered in the baseline topology but is either shut down or not connected to the cluster.

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.

Inspect configuration

Metrics Widgets

There are three types of widgets. Each type displays metrics in a particular form: chart, table, or histogram. A table can display multiple metrics. A chart and a 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, go to the tab, and click ADD WIDGET. Then, on the widget, click the icon. From the drop-down menu, select the scope. Then type the name of the metric you want to display.

Metrics widgets are updated every 5 seconds.

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

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.

Histogram

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

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.

Rebalance Widget