2.9. JBoss Cache Service 3
Overview
| Description: | The JBoss Cache instances on this server |
| Singleton: | no |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Search String | yes | searchString |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Cluster Config | trait | Cluster Config | ClusterConfig |
| Node Locking Scheme | trait | Node Locking Scheme | NodeLockingScheme |
| Expose Management Statistics? | trait | Expose Management Statistics? | ExposeManagementStatistics |
| Register JMX Resource? | trait | Register JMX Resource? | RegisterJmxResource |
| Cache Loader Configuration | trait | Cache Loader Configuration | CacheLoaderConfiguration |
| Multiplexer Stack | trait | Multiplexer Stack | MultiplexerStack |
| Replication Queue Max Elements | measurement | Replication Queue Max Elements | ReplQueueMaxElements |
| Number of Attributes | measurement | Number of Attributes | NumberOfAttributes |
| Cache Loader Config | trait | Cache Loader Config | CacheLoaderConfig |
| Cluster Name | trait | Cluster Name | ClusterName |
| Inactive on Startup? | trait | Inactive on Startup? | InactiveOnStartup |
| Cache Mode | trait | Cache Mode | CacheMode |
| Isolation Level | trait | Isolation Level | IsolationLevel |
| Replication Version | trait | Replication Version | ReplicationVersion |
| Fetch In-Memory State? | trait | Fetch In-Memory State? | FetchInMemoryState |
| Initial State Retrieval Timeout | measurement | Initial State Retrieval Timeout | InitialStateRetrievalTimeout |
| Buddy Replication Config | trait | Buddy Replication Config | BuddyReplicationConfig |
| Replication Queue Interval | measurement | Replication Queue Interval | ReplQueueInterval |
| Use Replication Queue? | trait | Use Replication Queue? | UseReplQueue |
| Use Region-Based Marshalling? | trait | Use Region-Based Marshalling? | UseRegionBasedMarshalling |
| Lock Acquisition Timeout | measurement | Lock Acquisition Timeout | LockAcquisitionTimeout |
| Number of Nodes | measurement | Number of Nodes | NumberOfNodes |
| Sync Commit Phase? | trait | Sync Commit Phase? | SyncCommitPhase |
| Sync Replication Timeout | measurement | Sync Replication Timeout | SyncReplTimeout |
| Eviction Policy Config | trait | Eviction Policy Config | EvictionPolicyConfig |
| State | trait | State | State |
| State Retrieval Timeout | measurement | State Retrieval Timeout | StateRetrievalTimeout |
| Transaction Manager Lookup Class | trait | Transaction Manager Lookup Class | TransactionManagerLookupClass |
| Cluster Properties | trait | Cluster Properties | ClusterProperties |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Destroy this cache. | |
| Stop this cache. | |
| Create this cache. | |
| Start this cache. | |
| Print lock information. | |
| Print cache details. | |
| Print cache details as HTML. | |
| Print configuration as plain text. | |
| Print lock info as HTML. | |
| Print configuration as HTML. |
Package Types
none
2.9.1. Data Container Service
Overview
| Description: | JBoss Cache Data Container |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Get the number of nodes. | Returns the number of nodes in the data container |
| Get the number of attributes. | Returns the number of nodes in the data container |
| Print details as plain text. | Prints details about the data container |
| Print details as HTML. | Prints details about the data container, formatted as HTML |
Package Types
none
2.9.2. Interceptor Service
Overview
| Description: | JBoss Cache Interceptor |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Evictions | measurement | the number of cache eviction operations | Evictions |
| Evictions per Minute | measurement | the number of cache eviction operations | Evictions |
| Hit/Miss Ratio | measurement | Hit/Miss Ratio | HitMissRatio |
| Read/Write Ratio | measurement | Read/Write Ratio | ReadWriteRatio |
| NumberOfNodes | measurement | the number of nodes in the cache | NumberOfNodes |
| Hits | measurement | the number of cache attribute hits | Hits |
| Hits per Minute | measurement | the number of cache attribute hits | Hits |
| Number Of Attributes | measurement | the number of cache attributes | NumberOfAttributes |
| Statistics Enabled | trait | Statistics Enabled | StatisticsEnabled |
| Elapsed Time | measurement | the time elapsed since the cache was started | ElapsedTime |
| Elapsed Time per Minute | measurement | the time elapsed since the cache was started | ElapsedTime |
| Time Since Reset | measurement | the time elapsed since the cache statistics were last reset | TimeSinceReset |
| Time Since Reset per Minute | measurement | the time elapsed since the cache statistics were last reset | TimeSinceReset |
| Misses | measurement | the number of cache attribute misses | Misses |
| Misses per Minute | measurement | the number of cache attribute misses | Misses |
| Average Write Time | measurement | the average amount of time per write operation | AverageWriteTime |
| Stores | measurement | the number of cache attribute put operations | Stores |
| Stores per Minute | measurement | the number of cache attribute put operations | Stores |
| Average Read Time | measurement | the average amount of time per read operation | AverageReadTime |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Reset Statistics | Reset all statistics. |
Package Types
none
2.9.3. Lock Manager Service
Overview
| Description: | MVCC Lock Manager |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Concurrency level | measurement | The concurrency level that the MVCC Lock Manager has been configured with. | concurrency level |
| Locks held | measurement | The number of exclusive locks that are held. | locks held |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
2.9.4. RegionManager Service
Overview
| Description: | JBoss Cache RegionManager |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number of Regions | measurement | the total number of regions | numRegions |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Dump Regions | Dump a list of all registered regions. |
Package Types
none
2.9.5. RPC Manager Service
Overview
| Description: | JBoss Cache RPC Manager |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| RPC Enabled? | trait | whether or not the RPC Manager is used in this cache instance | Enabled |
| Failed Replications | measurement | the number of failed replications | ReplicationFailures |
| Local Address | trait | Local address | LocalAddressString |
| Statistics Enabled | trait | Statistics Enabled | StatisticsEnabled |
| Successful Replications | measurement | the number of successful replications | ReplicationCount |
| Success Ratio | trait | RPC call success ratio | SuccessRatio |
| Members | trait | cluster view | MembersString |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Reset Statistics | Reset all statistics. |
Package Types
none
2.9.6. Transaction Table Service
Overview
| Description: | JBoss Cache TransactionTable |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Of Registered Transactions | measurement | the number of registered transactions | numberOfRegisteredTransactions |
| Transaction Map | trait | a string representation of the transaction map | transactionMap |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
| Name | Description |
|---|---|
| Reset Statistics | Reset all statistics. |
Package Types
none
2.9.7. Tx Interceptor Service
Overview
| Description: | JBoss Cache TxInterceptor |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
The Internal Name is what must be used to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Commits | measurement | the number of transaction commits | Commits |
| Statistics Enabled? | trait | a String representation of the transaction map | StatisticsEnabled |
| Rollbacks | measurement | the number of transaction rollbacks | Rollbacks |
| Prepares | measurement | the number of transaction prepares | Prepares |
| Number Of Syncs Registered | measurement | the number of transaction synchronizations currently registered | numberOfSyncsRegistered |
Note
The Internal Name is what must be used to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
