Using Pulse Views
Pulse provides a variety of different views to help you monitor Geode clusters, members, and regions.
The following sections provide an overview of the main Pulse views:
The cluster view is a high-level overview of the Geode distributed system. It is displayed immediately after you log into Pulse. Information displays around the perimeter of the cluster view show statistics such as memory usage, JVM pauses, and throughput. You can use the cluster view to drill down into details for individual members and regions in the distributed system.
Use these basic controls while in Cluster view:
- Click Members or Data to display information about Geode members or data regions in the distributed system.
Click the display icons to display the Geode members using icon view, block view, or table view. Note that icon view is available only when displaying Members.
For example, the following shows Geode Members displayed in table view:
- While in block view or table view, click the name of a Geode member to display additional information in the Member View.
- Click Topology, Server Groups, or Redundancy Zones to filter the view based on all members in the topology, configured server groups, or configured redundancy zones. The following shows Geode Regions displayed in table view:
- While in block view or table view, click the name of a Geode region to display additional information in the Region View.
While in icon view, click a host machine icon to display the Geode members on that machine.
In the Alerts pane, click the severity tabs to filter the message display by the level of severity.
Cluster View Screen Components
The following table describes the data pieces displayed on the Cluster View screen.
|Cluster Status||Overall status of the distributed system being monitored. Possible statuses include Normal, Warning, or Severe.|
|Total Heap||Total amount of memory (in GB) allocated to the Java heap across all members.|
|Members||Total number of members in the cluster.|
|Servers||Total number of servers in the cluster.|
|Clients||Total number of clients in the cluster.|
|Locators||Total number of locators in the cluster.|
|Regions||Total number of regions in the cluster.|
|Functions||Total number of functions registered in the cluster.|
|Unique CQs||Total number of unique CQs. Corresponds to the UNIQUE _CQ_QUERY statistic.|
|Subscriptions||Total number of client event subscriptions.|
|Cluster Members||Graphical, block, or table view of the members in the cluster.|
|Topology||Organizes cluster members by DistributedMember Id.|
|Server Groups||Organizes cluster members by server group membership. If no server groups are configured, all members appear under the “Default” server group.|
|Redundancy Zones||Organizes cluster members by redundancy zones. If no redundancy zones are configured, all members appear under the “Default” zone.|
|Host Machine||When you mouse over a machine icon in Topology View, a pop-up appears with the following machine statistics:
|Member||When you mouse over a member icon in Graphical View, a pop-up appears with the following member statistics:
|Member||In List View, the following data fields are displayed for each member:
|Key Statistics||Displays a few key performance measurements of the distributed system (over the last 15 minutes).|
|Write/Sec||Number of write operations per second that have occurred across the cluster. Each put/putAll operation counts as a write; for example, a putAll of 50 entries is counted as one write.|
|Read/Sec||Number of read operations per second that have occurred across the cluster.|
|Queries/Sec||Number of queries per second that have been executed across the cluster.|
|No. of JVM Pauses||Number of times the JVM has paused during the last five minutes to perform garbage collection.|
|WAN Information||If you have configured gateway senders or receivers for a multi-site (WAN) deployment, this box displays whether the remote cluster is reachable (working connectivity represented by a green triangle).|
|Disk Throughput||Total disk throughput for all disks in cluster.|
|Alerts View||Displays alerts for the cluster.|
When you select an individual Geode member in Cluster View, Pulse displays the regions available on that member, as well as member-specific information such as the configured listen ports.
Use these basic controls while in Member View:
- Click the display icons to display regions using block view or table view.
- Use the drop down menu to select a specific member or search for specific members by name.
- Click Cluster View to return to Cluster View. See Cluster View.
- Click Data Browser to query region data. See Data Browser.
Member View Screen Components
The following table describes the data elements displayed on the Member View screen.
|Member Status||Overall status of the member being monitored. Possible statuses include Normal, Warning, or Severe.|
|Regions||Total number of regions hosted on the member.|
|Threads||Total number of threads being executed on the member.|
|Sockets||Total number of sockets currently open on the member.|
|Load Avg.||Average number of threads on the member that are in the run queue or are waiting for disk I/O over the last minute. Corresponds to the Linux System statistic loadAverage1. If the load average is not available, a negative value is shown.|
|Clients||Current number of client connections to the member.|
|Member Regions||Block or table view of the regions hosted on the member.|
|Regions||When you mouse over a region in block view, a pop-up appears with the following data fields:
|Regions||In table view, the following fields are listed for each region:
|Member Clients||In table view, the following fields are listed for each client:
|Key Statistics||Displays a few key performance measurements for the member (over the last 15 minutes).|
|% CPU Usage||Percentage of CPU used by the member.|
|Read/Sec||Number of read operations per second that have occurred on the member.|
|Write/Sec||Number of write operations per second that have occurred on the member. Each put/putAll operation counts as a write; for example, a putAll of 50 entries is counted as one write.|
|Memory Usage||Total memory used on the member in MB.|
|No. of JVM Pauses||Number of times the JVM has paused during the last five minutes due to garbage collection or excessive CPU usage.|
|WAN Information||Displays cluster information. This dialog box only appears if you have configured WAN functionality (gateway senders and gateway receivers).|
|Disk Throughput||Rate of disk writes on the member.|
The Pulse Region View provides a comprehensive overview of all regions in the Geode distributed system:
Use these basic controls while in Region View:
Click the display icons to display all members that host the region using block view or table view.
(Click the name of a member to change to that member’s Member View.)
Search for specific members that host the current region.
Hover over a member name to display information such as the region entry count, entry size, and throughput on that member.
Region View Screen Components
The following table describes the data elements displayed on the Region View screen.
|Region Members||Lists information about Geode members that host the region, either in block view or table view.|
|Region Member (Detail View)||When you hover over a region member in block view, a pop-up appears with the following data fields:
|Region Member (Table View)||In table view, the following fields are listed for each region member:
|Region Detail||When you have selected a region, the right hand pane displays the following information about the region:
The Pulse Data Browser enables you to query region data. Note that there are two key attributes available on DistributedSystemMXBean (see List of Geode JMX MBeans) that you can use to configure limits for the result sets displayed in Data Browser:
QueryResultSetLimitlimits the number of rows that Data Browser queries return. 1000 rows are displayed by default.
QueryCollectionsDepthlimits the number of elements of a collection that Data Browser queries return. This attribute applies to query results contain collections such as Map, List, and so forth. The default value is 100 elements.
org.apache.geode.management.DistributedSystemMXBean JavaDocs for information on available MBean methods and attributes.
The following shows an example Data Browser view:
Use these basic controls while in Data Browser view:
- Search for the name of a specific region.
- Select one or more regions to display the Geode members that host those regions. The hosting Geode members appear in the Region Members section.
- Select one or more members from the Region Members section to restrict query results to those members.
- Type in the text of a query to execute. See Querying.
- Display a list of previously-executed queries. Double-click on a query from the history list to copy it to the Query Editor, or delete the query from your history.
- Execute your query or clear the contents of the Query Editor.
- View the current query results.
- Export the query results to a text file.
- Return to Cluster View.
The Alerts Widget appears in the right portion of the screen and displays a list of alerts.
The alerts displayed for the cluster appear based on the alertLevel field set in the DistributedSystemMXBean. By default, log messages with the level of SEVERE are shown as alerts. You can modify the level by using the
DistributedMXBean.changeAlertLevel method. See System Alert Notifications for more information.
Use these basic controls in the Alerts Widget:
- Select an alert level to view only alerts with a specific severity.
- Enter text in the search box to filter the list of alerts.
- Select an alert and click Clear to remove it from the alert list.
- Click Clear All to remove all alerts from the widget.
- Double-click an alert to open a pop-up window that displays the full text of the alert message.
- Click the check mark in an alert pop-up window to acknowledge the alert. Acknowledged alerts display a check mark in the list of alerts.
- Triple-click the alert in the pop-up or in the alert list to select the message text. You can then copy and paste the text into another application.
- Click the X to close the pop-up alert window.