Cassandra Tools - User Guide

Cassandra Tools feature enable user to easily manage a cassandra cluster.This feature provides user to perform the full set of functions in Cassandra Node Tools API.This feature fully implement using web services.Exposing the JMX to external world is a security vulnerability,because of that this feature implemented using web services. User can perform all the operations in Cassandra Node Tools by simple clicks in user interface.Which is more user friendly.

Interface

Feature contains of two interfaces.Interfaces named as "Cassandra Operations" and "Cassandra Stats".

Figure 1:Listed location in Carbon side menu

Cassandra Operations

This contains the all the cluster level,keyspace level and column family level operations such as backup,flush,scrub,shutting down RPC and Gossip servers and etc..

Figure 2:Cassandra Tools Operation

Cassandra Stats

This shows the all the stats and information available in the cluster.Cluster wide,keyspace level and column family level stats such as gossip info,column family histograms and etc.. is listed under this interfaces.

Figure 3:Cassandra Tools Stats

Node operations interface

Under the node operations user can be perform node wide operations available in Cassandra Node Tools.

Figure 4:Cassandra Tools Node Operation

Node level operation set

1. General
• Decommission

Decommission node cause to remove the node from the cluster.

• Move

Move node used to change the node currant token to the new token.This is important in load balancing of the cluster.



Figure 5:Move node

• Drain

Drain node used to flush the whole node and this cause to stop accepting write request to that node.

• Perform GC

Activate Garbage collector of the node.

• Join Ring

Triggers the specified node to join the ring. This assumes that the node was started with -Dcassandra.join_ring=false so that it did not join the ring upon startup.

2. BackUp
• Take Snapshot

This enable user to backup data in the node.



Figure 6:Take snapshot

• Clear Snapshot

User can clear the backup if needed.



Figure 7:Clear snapshot

• Enable Incremental Backup

Enable incremental backup use to backup data after when user already taken a backup.This function not fully backup all the data in the node,it used to write data to the exist backup when there are additional data comes to the backup after it taken.

3. Server
• Stop RPC

User can shutdown and start the RPC server of the node.

• Stop Gossip

User can shutdown and start the Gossip server of the node.

4. Other
• Remove Token

Using this operation user can remove a token in the cluster.Addition to it force remove completion operation listed under this operation while user can see the currant token removal status.

• Stop Compaction

User can stop any of listed permitted compaction under this operation.



Figure 8:Stop compaction

• Rebuild

User can specify a available data center for rebuild.



Figure 9:Rebuild

• Set Compaction Throughput

User can set the compaction throughput for the node.



Figure 10:Set compaction threshold

• Set Stream Throughput

User can set the stream throughput of the node.

Keyspace Operations

List of operations available for keyspaces are listed in this view

Figure 11:Keyspace operations

Keyspace level operation set

• Flush

Flushes memtables (in memory) to SSTables (on disk), which also enables CommitLog segments to be deleted.

• Compact

This operation trigger major compaction in all column families in the keyspace.This operation will compact multiple SS tables into single SS table.

• Scrub

Scrub will rebuild sstables with correct bloom filters, with no data lost. Note that nodetool scrub will snapshot your data files before rebuilding.

• Cleanup

This operation triggers cassandra to cleanup the keys which are not further belong to the node.

• UpgradeSSTables

Scrub does rebuild your sstables, it will also discard data it deems broken and create a snapshot, which you have to remove manually. If you just wish to rebuild your sstables without all that jazz, then best thing is to use upgradesstables". This is useful e.g. when you are upgrading your server, or changing compression options.

• Repair

Compared replica for each key responsible for the node and all replicas are updated to the newest available version.

• Take Snapshot

Backup the keyspace data.

• Clear snapshot

Clear the backup of a keyspace.

Column Family Operations

List of operations available for column families will be listed in view

Figure 12:Column family operations

Column family level operation set

• Flush
• Compact
• Scrub
• Cleanup
• UpgradeSSTables
• Repair

Note:All above operations are same as describe in keyspace operations and user can select multiple column families to perform operations.

• Take Snapshot

Backup the column family data data.

• Rebuild

Rebuild the column family.

• Rebuild with index

Rebuild column family by specifying indexes.



Figure 13:Rebuild with indexes

• Refresh

Refresh column family

• Set compaction thresholds

Set compaction thresholds for the column family.



Figure 14:Set compaction thresholds

Node Stats

This shows the stats available for node range

Figure 15:Node stats

Node level stats set

• Node Info

Outputs node information including the token, load info (on disk storage), generation number (times started), uptime in seconds, and heap memory usage.



Figure 16:Node info

• CF Stats

This outputs the column family information.such as read count,write count,read latency and etc..



Figure 17:CF stats

• Version

Outputs the cassandra version.

• Thread Pool Stats

Outputs the thread pool stats available for the node.

• Compaction Stats

Outputs the compaction stats of the node.

• Gossip Info

Outputs the gossip info of the node.

• Network Stats

Outputs the network stats of the selected host.

• Range Key

Range key available for the node.

Keyspace Stats

This interface listed the available for stats in keyspace range.

Figure 18:Keyspace stats

Keyspace level stat set

• Describe ring

Information about keyspace in the ring.

• Ownership

Load distributed in the keyspace across the cluster.

Column Family Stats

All the stats which is available in the column family level can be access through this interface.

Figure 19:Column family stats

Column family level stats set

• Histograms

Shows the column family histograms.

• Endpoints

Shows endpoint of the column family for a given key.

• SSTables

Shows SSTables of the column family for a given key.

• Compaction Thresholds

Shows the compaction thresholds for the column family.