Red Hat Training
A Red Hat training course is available for Red Hat JBoss Operations Network
4.3. RHQStorage - RHQ Storage Node Server
Overview
Table 4.54. Overview
| Description: | RHQ Storage Node |
| Singleton: | no |
| Plugin: | RHQStorage |
Child Resource Types
none
Autodiscovery Process Scans
Table 4.55. Metrics
| Name | Query |
|---|---|
| CassandraDaemon | process|basename|match=^java.*,arg|org.apache.cassandra.service.CassandraDaemon|match=.* |
Connection Properties
Table 4.56.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Manager URL | The RMI URL with which to connect to the RHQ Storage Node (e.g. service:jmx:rmi:///jndi/rmi://127.0.0.1:7399/jmxrmi). | yes | connectorAddress |
| Type | The type used to establish the EMS connection to the RHQ Storage Node. | yes | type |
| Base Directory | The base directory from which the Cassandra Daemon was launched. | no | baseDir |
| YAML Configuration File | YAML Configuration File | yes | yamlConfiguration |
| Jmx Port | The JMX port for the RHQ Storage Node | yes | jmxPort |
| Host | The host on which the RHQ Storage Node listens to CQL client connections | yes | host |
| Cluster Name | Cluster name | yes | clusterName |
| Command Line | the command line of the JVM at the time it was discovered - only used by JVMs with type Local; if the command line of the JVM changes, this property's value will need to be updated accordingly in order for RHQ to connect to the JVM | no | commandLine |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 4.57.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Min Heap Size | The minimum heap size. This value will be used with the -Xms JVM option. This is read only because it is automatically set to the same value as Max Heap Size. | yes | minHeapSize |
| Max Heap Size | The maximum heap size. This value will be used with the -Xmx JVM option. The value should be an integer with a suffix of M or G to indicate megabytes or gigabytes. | yes | maxHeapSize |
| Heap New Size | The size of the new generation portion of the heap. This value will be used with the -Xmn JVM option. The value should be an integer with a suffix of M or G to indicate megabytes or gigabytes. | yes | heapNewSize |
| Thread Stack Size | The thread stack size. This memory is allocated to each thread off heap. The value should be an integer that will be interpreted in kilobytes. | yes | threadStackSize |
| Heap Dump on OutOfMemoryError | Generate a heap dump when an OutOfMemoryError occurs | yes | heapDumpOnOOMError |
| Heap Dump Directory | The directory in which heap dumps will be written. | no | heapDumpDir |
| CQL Port | The port on which to listen for client requests over the native, CQL protocol. This is a shared, cluster-wide setting. | yes | cqlPort |
| Gossip Port | The port used for internode communication. This is a shared, cluster-wide setting. | yes | gossipPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 4.58. Metrics
| Name | Description |
|---|---|
| Shutdown | Shuts down the Cassandra daemon |
| Start | Starts the Cassandra daemon |
| Restart | Restarts the Cassandra daemon |
| Decommission | Take the storage node out of service. This operation is NOT intended for direct usage. It is part of the undeployment process. Please see the storage node (un)deployment documentation for more information. |
| Uninstall | Removes all of the storage node files from disk. This operation is NOT intended for direct usage. It is part of the undeployment process. Please see the storage node (un)deployment documentation for more information. |
| Repair | Runs anti-entropy repair on the primary range of rhq and system_auth keyspaces |
| Add Node Maintenance | This operation is NOT intended for direct usage. It is part of the deployment process. Please see the storage node deployment documentation for more information. |
| Remove Node Maintenance | This operation is NOT intended for direct usage. It is part of the undeployment process. Please see the storage node (un)deployment documentation for more information. |
| Announce | This operation is NOT intended for direct usage. It is part of the deployment process. Please see the storage node deployment documentation for more information. |
| Unannounce | This operation is NOT intended for direct usage. It is part of the undeployment process. Please see the storage node (un)deployment documentation for more information. |
| Prepare For Bootstrap | This operation is NOT intended for direct usage. It is part of the deployment process. Please see the storage node deployment documentation for more information. |
| Prepare For Upgrade | Prepares the storage node for upgrade (this operation consists of following steps: 1) turning off the RPC server, 2) turning off the gossiper, 3) taking the snapshot (backuping the data), 4) invoking the drain operation |
| Update Seeds List | Updatess the node's seeds property in cassandra.yaml |
| Take Snapshot | Takes a snapshot of all keyspaces. A snapshot first flushes all in-memory writes to disk and then creates a hard link of each SSTable file for the keyspace. Note that a column family can have multiple SSTables on disk. By default snapshots are stored in the <cassandra_data_dir>/<keyspace_name>/<column_family_name>/snapshots directory. On Linux/UNIX systems cassandra_data_dir defaults to /var/lib/cassandra/data |
| Update Configuration | Updates the node configuration. Will require a separate server restart for the settings to take effect. |
Package Types
none
