Chapter 25. Red Hat JBoss Data Grid Administration Console

25.1. About JBoss Data Grid Administration Console

The Red Hat JBoss Data Grid Administration Console allows administrators to monitor caches and JBoss Data Grid clusters, while providing a web interface for making dynamic changes to caches, cache-containers, and cluster nodes.

25.2. Red Hat JBoss Data Grid Administration Console Prerequisites

The Red Hat JBoss Data Grid Administration Console is only available in Remote Client-Server Mode.

25.3. Red Hat JBoss Data Grid Administation Console Getting Started

25.3.1. Red Hat JBoss Data Grid Administration Console Getting Started

The Administration Console is started automatically when JBoss Data Grid is running in Remote Client-Server Mode. A management user must be added to the server instance, which will then be used to access the web console.

25.3.2. Adding Management User

In order to use the JBoss Data Grid Administration Console, a new management user must be created. To add a new user, execute the add-user.sh utility script within the bin folder of your JBoss Data Grid Server installation and enter the requested information.

The following procedure outlines the steps to add a new management user:

Adding a Management User

  1. Run the add-user script within the bin folder as follows:

    ./add-user.sh
  2. Select the option for the type of user to be added. For management user, select option a.
  3. Set the Username and password as per the listed recommendations.
  4. Enter the name of the group or groups in which the user has to be added. Leave blank for no group.

    Note

    See the Download and Install JBoss Data Grid section in the Red Hat JBoss Data Grid Getting Started Guide for download and installation details.

  5. Confirm if you need the user to be used for Application Server process connection.

    Note

    Before proceeding, make sure $JBOSS_HOME is not set to a different installation. Otherwise, you may get unpredictable results.

25.3.3. Logging in the JBoss Data Grid Administration Console

Once the JBoss Data Grid server is running, in either domain or standalone mode, the JBoss Data Grid Administration Console may be accessed at the following login page:

http://${jboss.bind.address.management}:9990/console/index.html

Figure 25.1. JBoss Data Grid Administration Console Login Screen

Description

Enter the user credentials to log in. After logging in, the cache container view is displayed.

25.4. Dashboard View

25.4.1. Dashboard View

The Dashboard view is split into 3 tabs namely:

  • Caches
  • Clusters
  • Status Events
Note

The Clusters and Status Events tabs are not available when running JBoss Data Grid in standalone non-clustered mode.

25.4.2. Cache Containers View

The first default view after logging in is the Cache Container list. A Cache Container is the primary mechanism for treating a cache instance and is used as a starting point for using a cache itself.

Cache centric view presents the list of configured caches. It is used for viewing and adding caches to clusters, adding and adjusting new cache configurations, adding and configuring endpoints and other cache related administrative tasks.

Figure 25.2. Cache Containers View

Description

In this instance, there is one cache container with the name clustered with two caches deployed on the cluster group with UDP transport and three Endpoints attached to it. There are no remote sites configured for this cache container.

25.4.3. Clusters View

The Cluster tab presents the summary of the clusters along with the current status, number of hosts and number of nodes.

Figure 25.3. Clusters View

Description
Note

The Cluster view will not appear when the server is running in standalone non-clustered mode.

25.4.4. Status Events View

The JBoss Data Grid Administration Console displays the cluster wide events such as local rebalancing, cluster start and stop, cluster-split and cluster-merge events in a consolidated section. To view the detailed status events, navigate to the Status Events tab from the Dashboard.

Figure 25.4. Status Events View

Description

The status events are displayed with the associated timestamp and the event description.

Note

The Status Events view will not appear when the server is running in standalone non-clustered mode.

25.5. Cache Administration

25.5.1. Adding a New Cache

To add a new cache, follow these steps:

Adding a New Cache

  1. In the Cache Containers view, click on the name of the cache container.

    Figure 25.5. Cache Containers View

    Description
  2. The Caches view is displayed listing all the configured caches. Click Add Cache to add and configure a new cache. The new cache creation window is opened.

    Figure 25.6. Add Cache

    Description
  3. Enter the new cache name, select the base configuration template from the drop-down menu, check the Edit button, and click Next. If the Edit button is not selected then the cache will be immediately created using the selected template.

    Figure 25.7. Cache Properties

    Description
  4. The cache configuration screen is displayed. Enter the cache parameters and click Create.

    Figure 25.8. Cache Configuration

    Description
  5. A confirmation screen is displayed. Click Create to create the cache.

    Figure 25.9. Cache Confirmation

    Description

25.5.2. Editing Cache Configuration

The JBoss Data Grid Administration Console allows administrators to edit the configuration of an existing cache.

The following procedure outlines the steps to edit a cache configuration:

Editing Cache Configuration

  1. Log into the JBoss Data Grid Administration Console and click on the cache container name.

    Figure 25.10. Cache Containers

    7487
  2. In the Caches view, click on the cache name.

    Figure 25.11. Caches View

    7488
  3. The cache statistics and properties page is displayed. On the right hand side, click the Configuration tab.

    Figure 25.12. Cache Configuration Button

    7541
  4. The edit cache configuration interface is opened. The editable cache properties are found in the cache properties menu at the left hand side.

    Figure 25.13. Editing Cache Configuration Interface

    7490
  5. Select the cache configuration property to be edited from the cache properties menu along the left-hand side. To get a description on the cache configuration parameters, hover the cursor over the information icon to the right of each field. The parameter description is presented in form of a tooltip.

    Figure 25.14. Cache configuration paramaters

    7493
  6. The General property is selected by default. Edit the required values in the given parameter input fields and click Apply changes below
  7. The restart dialogue box appears. Click Restart Now to apply the changes, or Restart Later to continue editing the cache properties.

    Figure 25.15. Restart Dialogue Box

    7553
    Note

    In standalone mode the dialog instead contains the following text:

    Config changes will only be made available after you manually restart the server!

25.5.3. Cache Statistics and Properties View

The JBoss Data Grid Administration Console allows administrators to view all the cache statistics including the average time for reads, average times for writes, total number of entries, total number of reads, total number of failed reads and total number of writes.

To view the cache statistics, follow these steps:

Viewing Cache Statistics

  1. Navigate to the list of caches by clicking on the name of the cache container in the Cache Container view.
  2. Click on the name of the cache from the list of caches. Optionally you can use the cache filter on the left side to filter caches. The caches can be filtered by a keyword, substring or by selecting the type, the trait, and the status.

    Figure 25.16. Caches View

    7550
  3. The next page displays the comprehensive cache statistics under the headings: Cache content, Operations performance and Caching Activity.

    Figure 25.17. Cache Statistics

    7433
  4. Additional cache statistics are displayed under the headings: Entries Lifecycle, Cache Loader and Locking

    Figure 25.18. Cache Statistics

    7434
  5. To view cache properties, click on Configuration at the right hand side.

    Figure 25.19. Configuration Button

    7551
  6. The cache properties menu is displayed at the left hand side.

    Figure 25.20. Cache Properties Menu

    7485

To view on which node a cache resides, click on the Nodes tab next to the General Status tab on the cache statistics page.

Figure 25.21. General Status Tab

7435

The name of the Node(s) is displayed along with the read-write statistics.

Figure 25.22. Cache Node Labels

7486

25.5.4. Enable and Disable Caches

The following procedure outlines the steps to disable a cache:

Disabling a Cache

  1. Navigate to the caches view by clicking on the name of the cache container in the Cache Container view. Click on the name of the cache to be disabled.

    Figure 25.23. Caches View

    7495
  2. The cache statistics will be displayed. On the right hand side of the interface, click on the Actions tab and then click Disable.

    Figure 25.24. Cache Disable

    7437
  3. A confirmation dialogue box will appear. Click Disable to disable the cache.

    Figure 25.25. Cache Disable Confirmation

    7438
  4. A subsequent dialogue box appears. Click Ok.

    Figure 25.26. Confirmation Box

    7554
  5. The selected cache is disabled successfully with a visual indicator Disabled next to the cache name label.

    Figure 25.27. Disabled Cache

    7555

The following procedure outlines the steps to enable a cache:

Enabling a Cache

  1. To enable a cache, click on the specific disabled cache from the Cache view.

    Figure 25.28. Caches View

    7495
  2. On the right hand side of the interface, click on the Actions tab.

    Description
  3. From the Actions tab, click Enable

    Figure 25.29. Actions Menu

    7542
  4. A confirmation dialogue box appears. Click Enable.

    Figure 25.30. Confirmation Box

    7556
  5. A subsequent dialogue box appears. Click Ok

    Figure 25.31. Information Box

    7558
  6. The selected cache is enabled successfully with a visual indicator Enabled next to the cache name label.

    Figure 25.32. Cache Enabled

    7559

25.5.5. Cache Flush and Clear

The JBoss Data Grid Administration Console allows administrators to remove all the entries from a cache and the cache stores through the cache Clear operation. The console also provides the Flush operation to store the entries from the cache memory to the cache store. These entries are not removed from the cache memory, as during a Clear operation.

Flushing a Cache

To flush a cache, follow these steps:

Flushing a Cache

  1. In the Cache Containers view, click on the name of the cache container.
  2. The Caches view is displayed. Click on the cache to be flushed.

    Figure 25.33. Caches View

    7503
  3. The cache statistics page is displayed. At the right hand side, click Actions.

    Figure 25.34. Actions Button

    7504
  4. From the Actions menu, click Flush.

    Figure 25.35. Actions Menu

    7543
  5. A confirmation dialogue box appears. Click Flush.

    Figure 25.36. Cache Flush Confirmation Box

    7560
  6. The cache is successfully flushed. Click Ok.

    Figure 25.37. Cache Flush Information Box

    7561
Clearing a Cache

To clear a cache, follow these steps:

Clearing a Cache

  1. In the Cache Containers view, click on the name of the cache container.
  2. The Caches view is displayed. Click on the cache to be cleared.

    Figure 25.38. Caches View

    7503
  3. On the cache statistics page, at the right hand side, click Actions.

    7504
  4. From the Actions menu, click Clear.

    Figure 25.39. Clear Button

    7543
  5. A confirmation dialogue box appears. Click Clear.

    Figure 25.40. Confirmation Box

    7562
  6. The cache is successfully cleared. Click Ok.

    Figure 25.41. Information Box

    7563

25.5.6. Server Tasks Execution

The JBoss Data Grid Administration Console allows administrators to start a server script job on the JBoss Data Grid cluster.

25.5.7. Server Tasks

25.5.7.1. New Server Task

The following procedure outlines the steps to launch a new server task:

Note

Launching a new task is not supported if the server is running in standalone non-clustered mode.

Launching a New Server Task

  1. In the Cache Containers view of the JBoss Data Grid Administration Console, click on the name of the Cache container.
  2. On the cache view page, click the Task Execution tab.

    Figure 25.42. Task Execution

    7439
  3. In the Tasks execution tab, click Launch new task.

    Figure 25.43. Launch New Task

    7440
  4. Enter the new task properties and click Launch task.

    Figure 25.44. Task Properties

    7441

25.5.7.2. Server Tasks View

After the server task is launched, it can be viewed in the Task execution tab along with the other running tasks. The set of completed server script jobs with the start time and end time can be viewed. Additionally, number of successful executions and number of failed executions can also be viewed.

Figure 25.45. Server Tasks View

7442

Figure 25.46. Task Start/End Time

7443

25.6. Cache Container Configuration

25.6.1. Cache Container Configuration

The JBoss Data Grid Administration Console allows users to view and set Cache Container level settings such as transport, thread pools, security, cache templates, deployment of remote Executables/Scripts. Each cache container is associated with a cluster.

The following procedure outlines the steps to aceess the Cache Container Configuration settings:

Accessing Cache Container Configuration Settings

  1. In the Cache Container View, click on the name of the cache container.

    Figure 25.47. Cache Container View

    7446
  2. Click Configuration setting button at the top right hand side of the interface.

    Figure 25.48. Configuration

    7444

The Cache Container Configuration interface is displayed.

Figure 25.49. Cache Container Configuration

7445

25.6.2. Defining Protocol Buffer Schema

A Protocol Buffer Schema is defined in the Cache Container Configuration interface.

The following procedure outlines the steps to define a protobuf schema:

Defining a Protobuf Schema

  1. Click Add at the right hand side of the Schema tab to launch the create schema window.
  2. Enter the schema name and the schema in the respective fields and click Create Schema.

    Figure 25.50. New Schema

    7448
  3. The protocol buffer schema is added.

    Figure 25.51. Protocol Buffer

    7449

25.6.3. Transport Setting

To access the Transport setting, click on the Transport tab in the Cache Container Configuration interface. Enter the Transport settings and click Save .

Figure 25.52. Transport Setting

7450

A dialog box will prompt to restart the server due to configuration changes. Restart to apply the changes.

Figure 25.53. Restart Confirmation

7451

25.6.4. Defining Thread Pools

To define thread pools for different cache related operations, click on the Thread Pools tab in the Cache Container Configuration interface.

The JBoss Data Grid Administration Console allows administrators to set Thread Pool values for the following cache level operations:

Async Operations

Figure 25.54. Async Operations

7510

The currently set value for each parameter is set by the console. Hover the cursor over the information icon to view the parameter description in form of a tooltip. To change a thread pool value, enter the new value in the parameter field and click Save . A server restart is needed after every change of values.

Expiration

For Expiration settings, the user can set values for the following parameters:

Figure 25.55. Expiration Values

7511

Listener

For Listener settings, the user can set values for the following parameters:

Figure 25.56. Listener Values

7513

Persistence

For Persistence settings, the user can set values for the following parameters:

Figure 25.57. Persistence Values

7514

Remote Commands

For Remote Commands settings, the user can set values for the following parameters:

Figure 25.58. Remote Commands

7515

Replication Queue

For Replication Queue settings, the user can set values for the following parameters:

Figure 25.59. Replication Queue Values

7516

State Transfer

For Listener settings, the user can set values for the following parameters:

Figure 25.60. State Transfer Values

7517

Transport

For Transport settings, the user can set values for the following parameters:

Figure 25.61. Transport Values

7518

25.6.5. Adding New Security Role

The following procedure outlines the steps to add a new security role:

Adding a Security Role

  1. Click on the Security tab. If authorization is not defined for a cache container, click Yes to define.

    Figure 25.62. Define Authorization

    7452
  2. Select the Role Mapper from the drop-down menu. Click Add to launch the permissions window.

    Figure 25.63. Role Mapper Selection

    7453
  3. In the Permissions window, enter the name of the new role and assign the permissions by checking the required check-boxes. Click Save changes to save the role.

    Figure 25.64. Role Permissions

    7454
  4. The new security role is added.

    Figure 25.65. New Security Role

    7455

25.6.6. Creating Cache Configuration Template

The Templates tab in the Cache Container Configuration interface lists all the configured and available cache templates.

Figure 25.66. Cache Templates View

7544

The following procedure outlines the steps to create a new Cache configuration template :

Creating New Cache Configuration Template

  1. Click Create new Template on the right hand side of the templates list.
  2. Enter the cache configuration template name and select the base configuration from the drop-down and click Next.

    Figure 25.67. Cache Configuration Template

    7457
  3. Set the cache template attributes for the various cache operations such as Locking, Expiration, Indexing and others.

    Figure 25.68. Cache Configuration Template

    7458
  4. After entering the values, click Create to create the Cache Template.

25.7. Cluster Administration

25.7.1. Cluster Nodes View

Clusters centric view allows to view the nodes created for each server group and the list of deployed servers can be viewed. In Clusters view, you can add new nodes to the cluster group and view performance metrics of the particular nodes.

Note

The Cluster view will not appear when the server is running in standalone non-clustered mode. When running in standalone clustered mode the Cluster view will be displayed, but no operations on cluster nodes may be performed.

To access the Clusters view, navigate to the Clusters tab from the Dashboard and click on the name of the cluster.

Figure 25.69. Nodes View

7545

25.7.2. Cluster Nodes Mismatch

The total number of server nodes on the JBoss Data Grid cluster should ideally match the number of nodes shown in the JBoss Data Grid Administration Console. If in case, due to some reason, the expected nodes in the console do not match with the exact number of nodes on the JBoss Data Grid physical cluster, the console issues a mismatch warning by displaying the number of nodes detected and the number of expected nodes. Knowing the expected number of server nodes helps in handling Network Partitions.

If nodes mismatch occurs, it can be viewed in the clusters view, above the list of nodes as a warning. To access the Clusters view, navigate to the Clusters tab from the Dashboard and click on the name of the cluster.

In the following screen, the Console alerts the user in the form of a warning. The expected number of server nodes are 5 but only 3 are detected by the console.

Figure 25.70. Cluster Nodes Mismatch

Description

25.7.3. Cluster Rebalancing

The Red Hat JBoss Data Grid Administration Console allows the user to enable and disable cluster rebalancing at the cache container and cache levels.

Note

Cluster rebalancing is enabled by default.

The following procedure outlines the steps to enable and disable cluster rebalancing at a cache container level :

Enable and Disable Rebalancing

  1. From the cache container view, click on the name of the cache container.
  2. In the caches view, at the right hand side, click on Actions.

    7534
  3. A callout menu is opened. Click Disable Rebalancing.

    7521
  4. A confirmation dialogue box appears. Click Accept.

    7522
  5. Cluster rebalancing is successfully disabled.

    7523
  6. To enable rebalancing, click Actions Enable Rebalancing.

    7524
  7. A confirmation dialogue box appears. Click Accept.

    7525

Rebalancing is successfully enabled.

7526

The following procedure outlines the steps to enable and disable cluster rebalancing at a cache level :

Enable and Disable Rebalancing

  1. From the cache container view, click on the name of the cache container.
  2. In the caches view, click on a specific cache.
  3. The cache statistics page is displayed. At the right hand side, click Actions.

    7534
  4. From the callout menu, click Disable Rebalance.

    7528
  5. A confirmation dialogue box appears. Click Disable Rebalance.

    7529
  6. The rebalancing for the cache is successfully disabled.

    7530
  7. To enable cache level rebalancing, click Enable rebalance from the Actions menu.

    7531
  8. A confirmation dialogue box appears. Click Enable rebalance.

    7533

The rebalancing for the cache is successfully enabled.

7532

25.7.4. Cluster Partition Handling

The JBoss Data Grid Administration Console alerts the user with a visual warning when the cluster changes state to DEGRADED.

The assumed causes for a DEGRADED cluster are occurrence of a network partition, unreachable node(s) or unexpected extra nodes.

The visual warning is displayed in the Clusters view.

To access the Clusters view, navigate to the Clusters tab from the Dashboard and click on the name of the cluster.

In the following screen, the visual warning DEGRADED is displayed next to the cluster name JDG Cluster #1.

Figure 25.71. Network Partition Warning

7546

This visual warning for a DEGRADED cluster is shown at Cluster, Cache Container, and Cache levels of the console.

Note

Partitions can enter Degraded mode only if the DENY_READ_WRITES partition handling strategy is configured. Otherwise all partitions are AVAILABLE in the JBoss Data Grid Administration Console.

25.7.5. Cluster Events

The JBoss Data Grid Console displays the cluster wide events such as cluster-split and cluster-merge events in a consolidated section.

Note

Cluster Events are not available when the server is running in standalone non-clustered mode.

Along with the cluster events, the console displays the timestamp of the associated event. Cluster events can be viewed in the Cache containers page, the Clusters view page and also in the Status Events tab of the Dashboard.

To view cluster events on the cache containers page, navigate to the default cache containers view which is the default landing interface after logging into the console. The Cluster events are displayed at the right hand side in a consolidated section under the title Latest Grid Events

7535

To view the cluster events on the Clusters view page, navigate to the Clusters view by clicking on the Clusters tab. The Cluster events are displayed at the right hand side in a consolidated section under the title Latest status Events

7536

25.7.6. Adding Nodes

The JBoss Data Grid Administration Console allows administrators to configure new nodes.

The following procedure outlines the steps to add a new Node:

Adding a New Node

  1. In the Dashboard view, click Cluster tab.

    Figure 25.72. Clusters Tab

    7460
  2. Click on the name of the cluster where the new node has to be added.

    Figure 25.73. Cluster Selection

    7461
  3. Click Add Node.

    Figure 25.74. Add Node Created

    7462
  4. The node configuration window is opened. Enter the node properties in the respective fields and click Create

    Figure 25.75. Node Properties

    7565
  5. The system boots up.

    Figure 25.76. System Boot

    7463
  6. The new node is successfully created.

    Figure 25.77. New Node

    7464

25.7.7. Node Statistics and Properties View

JBoss Data Grid Administration Console allows users to view the average time for reads, average times for writes, total number of entries, total number of reads, total number of failed reads, total number of writes and other data.

To view the Node statistics, click on the name of the Node in the Clusters tab on the JBoss Data Grid Administration Console.

Figure 25.78. Nodes Statistics

7547

25.7.8. Node Performance Metrics View

To view the Node performance metrics, click on the name of the node in the Clusters tab of the JBoss Data Grid Administration Console

Figure 25.79. Node Performance Metrics

7466

25.7.9. Disabling a Node

The JBoss Data Grid Administration Console allows administrators to disable nodes.

To disable a node of a cluster, follow these steps:

Adding a New Node

  1. Click on the name of the cluster in the Cluster View of the JBoss Data Grid Administration Console.
  2. In the Nodes view, click on the node to be disabled.

    Figure 25.80. Nodes View

    7467
  3. The Node statistics view is opened. Click on the Actions tab located at the right hand side of the page and then click Stop.

    Figure 25.81. Nodes Stop

    7468
  4. A confirmation box appears. Click Stop to shut down the node.

    Figure 25.82. Confirmation Box

    7566

25.7.10. Cluster Shutdown and Restart

25.7.10.1. Cluster Shutdown

JBoss Data Grid Administration Console allows convenient and controlled shutdown of JBoss Data Grid clusters for maintenance purposes. For caches with a configured cache store, the data will be persisted without any data loss.For caches without a configured cache store, data will be lost after cluster shutdown.

To shut down or stop a cluster, follow these steps:

Shutting Down Cluster

  1. Navigate to the Clusters view in the JBoss Data Grid Administration console and click on the name of the cluster.

    Figure 25.83. Clusters View

    7470
  2. On the Nodes view page, locate the Actions tab to the top right hand side of the interface. Click on Actions tab and then click Stop.

    Figure 25.84. Cluster Stop

    7471
  3. A confirmation box will appear. To confirm, click Stop.

    Figure 25.85. Confirmation Box

    7472

25.7.10.2. Cluster Start

JBoss Data Grid Administration Console allows restarting a stopped cluster. The cache data is preloaded without any data loss for caches with configured cache-store. Caches without a configured cache store, will initially contain no data.

Preloading will only happen if preload is enabled on the cache store. If the local cache state on one of the nodes is corrupt, the cache will not start and manual intervention will be required.

To a cluster, follow these steps:

Starting Cluster

  1. Navigate to the Clusters view in the JBoss Data Grid Administration console and click on the name of the cluster.
  2. On the Nodes view page, locate the Actions tab to the top right hand side of the interface. Click on Actions tab and then click Start.

    Figure 25.86. Cluster Start

    7473
  3. A confirmation box will appear. Click Start to start the cluster.