22.6. JBoss Operations Network Remote-Client Server Plugin

22.6.1. JBoss Operations Network Plugin Metrics

Table 22.1. JBoss Operations Network Traits for the Cache Container (Cache Manager)

Trait Name Display Name Description
cache-manager-status Cache Container Status The current runtime status of a cache container.
cluster-name Cluster Name The name of the cluster.
members Cluster Members The names of the members of the cluster.
coordinator-address Coordinator Address The coordinator node's address.
local-address Local Address The local node's address.
version Version The cache manager version.
defined-cache-names Defined Cache Names The caches that have been defined for this manager.

Table 22.2. JBoss Operations Network Metrics for the Cache Container (Cache Manager)

Metric Name Display Name Description
cluster-size Cluster Size How many members are in the cluster.
defined-cache-count Defined Cache Count How many caches that have been defined for this manager.
running-cache-count Running Cache Count How many caches are running under this manager.
created-cache-count Created Cache Count How many caches have actually been created under this manager.

Table 22.3. JBoss Operations Network Traits for the Cache

Trait Name Display Name Description
cache-status Cache Status The current runtime status of a cache.
cache-name Cache Name The current name of the cache.
version Version The cache version.

Table 22.4. JBoss Operations Network Metrics for the Cache

Metric Name Display Name Description
cache-status Cache Status The current runtime status of a cache.
number-of-locks-available [LockManager] Number of locks available The number of exclusive locks that are currently available.
concurrency-level [LockManager] Concurrency level The LockManager's configured concurrency level.
average-read-time [Statistics] Average read time Average number of milliseconds required for a read operation on the cache to complete.
hit-ratio [Statistics] Hit ratio The result (in percentage) when the number of hits (successful attempts) is divided by the total number of attempts.
elapsed-time [Statistics] Seconds since cache started The number of seconds since the cache started.
read-write-ratio [Statistics] Read/write ratio The read/write ratio (in percentage) for the cache.
average-write-time [Statistics] Average write time Average number of milliseconds a write operation on a cache requires to complete.
hits [Statistics] Number of cache hits Number of cache hits.
evictions [Statistics] Number of cache evictions Number of cache eviction operations.
remove-misses [Statistics] Number of cache removal misses Number of cache removals where the key was not found.
time-since-reset [Statistics] Seconds since cache statistics were reset Number of seconds since the last cache statistics reset.
number-of-entries [Statistics] Number of current cache entries Number of entries currently in the cache.
stores [Statistics] Number of cache puts Number of cache put operations
remove-hits [Statistics] Number of cache removal hits Number of cache removal operation hits.
misses [Statistics] Number of cache misses Number of cache misses.
success-ratio [RpcManager] Successful replication ratio Successful replications as a ratio of total replications in numeric double format.
replication-count [RpcManager] Number of successful replications Number of successful replications
replication-failures [RpcManager] Number of failed replications Number of failed replications
average-replication-time [RpcManager] Average time spent in the transport layer The average time (in milliseconds) spent in the transport layer.
commits [Transactions] Commits Number of transaction commits performed since the last reset.
prepares [Transactions] Prepares Number of transaction prepares performed since the last reset.
rollbacks [Transactions] Rollbacks Number of transaction rollbacks performed since the last reset.
invalidations [Invalidation] Number of invalidations Number of invalidations.
passivations [Passivation] Number of cache passivations Number of passivation events.
activations [Activations] Number of cache entries activated Number of activation events.
cache-loader-loads [Activation] Number of cache store loads Number of entries loaded from the cache store.
cache-loader-misses [Activation] Number of cache store misses Number of entries that did not exist in the cache store.
cache-loader-stores [CacheStore] Number of cache store stores Number of entries stored in the cache stores.

Note

Gathering of some of these statistics is disabled by default.
JBoss Operations Network Metrics for Connectors

The metrics provided by the JBoss Operations Network (JON) plugin for Red Hat JBoss Data Grid are for REST and Hot Rod endpoints only. For the REST protocol, the data must be taken from the Web subsystem metrics. For details about each of these endpoints, see the Getting Started Guide.

Table 22.5. JBoss Operations Network Metrics for the Connectors

Metric Name Display Name Description
bytesRead Bytes Read Number of bytes read.
bytesWritten Bytes Written Number of bytes written.

Note

Gathering of these statistics is disabled by default.

22.6.2. JBoss Operations Network Plugin Operations

Table 22.6. JBoss ON Plugin Operations for the Cache

Operation Name Description
Start Cache Starts the cache.
Stop Cache Stops the cache.
Clear Cache Clears the cache contents.
Reset Statistics Resets statistics gathered by the cache.
Reset Activation Statistics Resets activation statistics gathered by the cache.
Reset Invalidation Statistics Resets invalidations statistics gathered by the cache.
Reset Passivation Statistics Resets passivation statistics gathered by the cache.
Reset Rpc Statistics Resets replication statistics gathered by the cache.
Remove Cache Removes the given cache from the cache-container.
Record Known Global Keyset Records the global known keyset to a well-known key for retrieval by the upgrade process.
Synchronize Data Synchronizes data from the old cluster to this using the specified migrator.
Disconnect Source Disconnects the target cluster from the source cluster according to the specified migrator.
JBoss Operations Network Plugin Operations for the Cache Backups

The cache backups used for these operations are configured using cross-datacenter replication. In the JBoss Operations Network (JON) User Interface, each cache backup is the child of a cache. For more information about cross-datacenter replication, see Chapter 31, Set Up Cross-Datacenter Replication

Table 22.7. JBoss Operations Network Plugin Operations for the Cache Backups

Operation Name Description
status Display the site status.
bring-site-online Brings the site online.
take-site-offline Takes the site offline.
Cache (Transactions)

Red Hat JBoss Data Grid does not support using Transactions in Remote Client-Server mode. As a result, none of the endpoints can use transactions.

23149%2C+Administration+and+Configuration+Guide-6.628-06-2017+13%3A51%3A02JBoss+Data+Grid+6Documentation6.6.1Report a bug

22.6.3. JBoss Operations Network Plugin Attributes

Table 22.8. JBoss ON Plugin Attributes for the Cache (Transport)

Attribute Name Type Description
cluster string The name of the group communication cluster.
executor string The executor used for the transport.
lock-timeout long The timeout period for locks on the transport. The default value is 240000.
machine string A machine identifier for the transport.
rack string A rack identifier for the transport.
site string A site identifier for the transport.
stack string The JGroups stack used for the transport.

22.6.4. Create a New Cache Using JBoss Operations Network (JON)

Use the following steps to create a new cache using JBoss Operations Network (JON) for Remote Client-Server mode.

Procedure 22.3. Creating a new cache in Remote Client-Server mode

  1. Log into the JBoss Operations Network Console.
    1. From from the JBoss Operations Network console, click Inventory.
    2. Select Servers from the Resources list on the left of the console.
  2. Select the specific Red Hat JBoss Data Grid server from the servers list.
    1. Below the server name, click infinispan and then Cache Containers.
  3. Select the desired cache container that will be parent for the newly created cache.
    1. Right-click the selected cache container. For example, clustered.
    2. In the context menu, navigate to Create Child and select Cache.
  4. Create a new cache in the resource create wizard.
    1. Enter the new cache name and click Next.
    2. Set the cache attributes in the Deployment Options and click Finish.

Note

Refresh the view of caches in order to see newly added resource. It may take several minutes for the Resource to show up in the Inventory.