Skip to content
Nir edited this page Apr 6, 2016 · 30 revisions

The NodeTool command 2.1.8

The nodetool is a command line utility that uses the JMX API to query a node and perform actions on it. This document describes the supported nodetool commands and output, note that due to the different implementation, there could be some minor changes between Scylla and Cassandra.

cfhistograms

Provides statistics about a table that could be used to plot a frequency function.

keyspace1/standard1 histograms
Percentile  SSTables     Write Latency      Read Latency    Partition Size        Cell Count
                              (micros)          (micros)           (bytes)                  
50%             0.00           6866.00              0.00                 0                 0
75%             0.00           6866.00              0.00                 0                 0
95%             0.00           8239.00              0.00                 0                 0
98%             0.00           9887.00              0.00                 0                 0
99%             0.00           9887.00              0.00                 0                 0
Min             0.00           2300.00              0.00                 0                 0
Max             0.00        2346799.00              0.00                 0                 0
Field meaning
SSTables Number of sstable per read
Write Latency Write latency
Read Latency Read latency
Partition Size Estimated row size
Cell Count Estimated column count
##cfstats [keyspace]
Provides statistics about tables per keyspace.
If the optional keyspace is provided, only tables from that keyspace will be provided.

An output example of the command

Keyspace: keyspace1
	Read Count: 0
	Read Latency: NaN ms.
	Write Count: 41656
	Write Latency: 0.016199467063568274 ms.
	Pending Flushes: 0
		Table: standard1
		SSTable count: 17
		SSTables in each level: [ ]
		Space used (live): 28331544
		Space used (total): 38060888
		Space used by snapshots (total): 0
		Off heap memory used (total): 5505072
		SSTable Compression Ratio: 0.0
		Number of keys (estimate): 26829
		Memtable cell count: 4868
		Memtable data size: 4128083
		Memtable off heap memory used: 4980736
		Memtable switch count: 0
		Local read count: 0
		Local read latency: NaN ms
		Local write count: 41656
		Local write latency: 0.014 ms
		Pending flushes: 0
		Bloom filter false positives: 0
		Bloom filter false ratio: 0.00000
		Bloom filter space used: 0
		Bloom filter off heap memory used: 524336
		Index summary off heap memory used: 0
		Compression metadata off heap memory used: 0
		Compacted partition minimum bytes: 259
		Compacted partition maximum bytes: 310
		Compacted partition mean bytes: 310
		Average live cells per slice (last five minutes): 0.0
		Maximum live cells per slice (last five minutes): 0.0
		Average tombstones per slice (last five minutes): 0.0
		Maximum tombstones per slice (last five minutes): 0.0

----------------

.......
.....

Fields explenation

Field meaning
Keyspace The keyspace name
Read Count The total number of reads count since boot
Read Latency The average read latency
Write Count The total number of writes since boot
Write Latency The average read latency
Pending Flushes Number of flushes that start but did not finished yet
Table table (column family) name
SSTable count The number of live sstable
SSTables in each level In leveled compaction report the number of sstables and size per level
Space used (live) The disk space of the live sstables
Space used (total) The disk space of all sstables
Space used by snapshots (total) The space on disk used by snapshots
Off heap memory used (total) The memory used by memtable, bloom filter, index summary and compression metadata
SSTable Compression Ratio
Number of keys (estimate) The estimated row count (based on the estimated histogram)
Memtable cell count memtable column count
Memtable data size Used space of lived memetable
Memtable off heap memory used Memory taken by all memtable. In syclla, all memory is off heap
Memtable switch count The number sstable was switched (flushed)
Local read count Number of read operations
Local read latency Mean read operation time
Local write count Number of write operation
Local write latency Mean write operation time
Pending flushes Number of sstables waiting to be flushed
Bloom filter false positives Number of false positive made by the bloom filter
Bloom filter false ratio The ratio between the false positive and overall attempts
Bloom filter space used Memory taken by the bloom filter
Bloom filter off heap memory used In scylla all memory is off heap
Index summary off heap memory used Memory taken by the Index summary
Compression metadata off heap memory used
Compacted partition minimum bytes
Compacted partition maximum bytes
Compacted partition mean bytes
Average live cells per slice (last five minutes)
Maximum live cells per slice (last five minutes)
Average tombstones per slice (last five minutes)
Maximum tombstones per slice (last five minutes)

##clearsnapshot Removes one or more snapshots.

##compact Forces a major compaction on one or more tables.

##compactionhistory Print history of compaction

Compaction History: 
id                                       keyspace_name      columnfamily_name            compacted_at              bytes_in       bytes_out      rows_merged
3f45d200-a3fa-11e5-bb28-000000000001     system             local                        1450273090336             816            690            
3f4583e0-a3fa-11e5-9dc2-000000000000     system             peers                        1450273090334             20             20 

##decommission Deactivates a node by streaming its data to another node.

##describecluster Provide the name

Cluster Information:
	Name: CassandraCluster
	Snitch: org.apache.cassandra.locator.SimpleSnitch
	Partitioner: org.apache.cassandra.dht.Murmur3Partitioner
	Schema versions:
		c846d9a9-2bf5-3b04-a326-c518968ead7f: [10.149.143.36]

Field meaning
Name The cluster name
Snitch The name of the snitch being used
Partitioner The name of the Partitioner being used
schema versions for each of the schema version a list of the node with that version
##describering keyspace
Schema Version:c846d9a9-2bf5-3b04-a326-c518968ead7f
TokenRange: 
	{"end_token":"","start_token":"","endpoint_details":[{"datacenter":"datacenter1","host":"10.149.143.36","rack":"rack1"}],"endpoints":["10.149.143.36"],"rpc_endpoints":["10.149.143.36"]}
	{"end_token":"","start_token":"","endpoint_details":[{"datacenter":"datacenter1","host":"10.158.134.89","rack":"rack1"}],"endpoints":["10.158.134.89"],"rpc_endpoints":["Value(10.158.134.89,3)"]}
	{"end_token":"","start_token":"","endpoint_details":[{"datacenter":"datacenter1","host":"10.149.143.36","rack":"rack1"}],"endpoints":["10.149.143.36"],"rpc_endpoints":["10.149.143.36"]}
	{"end_token":"","start_token":"","endpoint_details":[{"datacenter":"datacenter1","host":"10.149.143.36","rack":"rack1"}],"endpoints":["10.149.143.36"],"rpc_endpoints":["10.149.143.36"]}

##disablegossip Disables the gossip protocol.

##enablegossip Enables the gossip portocol

##flush Flushes one or more tables from the memtable.

##getendpoints

##gossipinfo Provides the gossip information for the cluster.

/127.0.0.2
  generation:1451207605
  heartbeat:21
  LOAD:24823
  NET_VERSION:0
  HOST_ID:f6180d07-caeb-49dc-896d-dc109903123f
  SCHEMA:59adb24e-f3cd-3e02-97f0-5b395827453f
  RELEASE_VERSION:2.1.8
  STATUS:NORMAL,961454230243343707
  RPC_ADDRESS:127.0.0.2
  RACK:rack1
  DC:datacenter1
/127.0.0.1
  generation:1451207601
  heartbeat:25
  LOAD:12646
  NET_VERSION:0
  HOST_ID:a51ac17e-d886-4ae4-af8a-485380d995f0
  SCHEMA:59adb24e-f3cd-3e02-97f0-5b395827453f
  RELEASE_VERSION:2.1.8
  STATUS:NORMAL,974300876456542556
  RPC_ADDRESS:127.0.0.1
  RACK:rack1
  DC:datacenter1
Field meaning
generation
heartbeat heart beat version
LOAD
NET_VERSION
HOST_ID
SCHEMA
RELEASE_VERSION
STATUS
RPC_ADDRESS
RACK
DC
##info [-T]
Provides node information, with the -T flag all tokens will be displayed
ID                     : d5c9b6fa-702a-44e2-be96-2e08f376d6f7
Gossip active          : true
Thrift active          : false
Native Transport active: true
Load                   : 221.44 KB
Generation No          : 1448195630
Uptime (seconds)       : 3024
Heap Memory (MB)       : 398.33 / 13419.00
Off Heap Memory (MB)   : 341.63
Data Center            : datacenter1
Rack                   : rack1
Exceptions             : 0
Key Cache              : entries 0, size 0 bytes, capacity 0 bytes, 0 hits, 0 requests, 0.000 recent hit rate, 0 save period in seconds
Row Cache              : entries 11, size 11 bytes, capacity 2.02 MB, 591 hits, 680 requests, 0.869 recent hit rate, 0 save period in seconds
Counter Cache          : entries 0, size 0 bytes, capacity 0 bytes, 0 hits, 0 requests, 0.000 recent hit rate, 0 save period in seconds
Token                  : (invoke with -T/--tokens to see all 512 tokens)
Field meaning

##netstats Provides network information about the host.

Mode: NORMAL
Bootstrap 331955a0-aeff-11e5-895c-000000000000
    /127.0.0.2
        Sending 1 files, 140724545317112 bytes total. Already sent 0 files, 0 bytes total
Read Repair Statistics:
Attempted: 6
Mismatch (Blocking): 0
Mismatch (Background): 0
Pool Name                    Active   Pending      Completed
Commands                        n/a         0            121
Responses                       n/a         0             64

##move < new token > This command moves a node from one token to another. It can be used only with a single token per node and not with vnodes. The new token must be an unused token by any of the nodes. You can use the nodetool ring command to check the tokens.

##rebuild < src-dc-name > Rebuild data by streaming from other nodes (similarly to bootstrap) ##refresh Loads newly placed SSTables onto the system without a restart.

##repair Repairs one or more tables.

##ring Provides node status and information about the ring.

Datacenter: datacenter1
==========
Address        Rack        Status State   Load            Owns                Token                                       
                                                                              3235011295660847148                         
10.158.134.89  rack1       Up     Normal  226770          ?                   5814024176193311729                         
10.149.143.36  rack1       Up     Normal  226756          ?                   3547879923707442398                         
10.158.134.89  rack1       Up     Normal  226770          ?                   -4538640785541824867                        
10.158.134.89  rack1       Up     Normal  226770          ?                   9207030900594355020                         
10.158.134.89  rack1       Up     Normal  226770          ?                   -5179793519300242259                        
10.149.143.36  rack1       Up     Normal  226756          ?                   4487440605876152831                         
10.149.143.36  rack1       Up     Normal  226756          ?                   5953645436436481254                         
..........
..........                     
10.149.143.36  rack1       Up     Normal  226756          ?                   3235011295660847148                         

  Warning: "nodetool ring" is used to output all the tokens of a node.
  To view status related info of a node use "nodetool status" instead.


  Note: Non-system keyspaces don't have the same replication settings, effective ownership information is meaningless

##snapshot [-cf , --column-famiy ] [-kc , --kc-list , -t ] Take a snapshot of the system. Snapshots can be global, on keyspace level or on column family level.

nodetool snapshot 
Requested creating snapshot(s) for [all keyspaces] with snapshot name [1449391097594]
Snapshot directory: 1449391097594

When using the command without any parameters it would create a snapshot of all keyspaces and all column family

##status [keyspace] Print the cluster information for a single or all keypsaces

Datacenter: datacenter1
=======================
Status=Up/Down
|/ State=Normal/Leaving/Joining/Moving
--  Address    Load       Tokens  Owns (effective)  Host ID                               Rack
UN  127.0.0.1  394.97 MB  256     48.7%             292a6c7f-2063-484c-b54d-9015216f1750  rack1
UN  127.0.0.2  151.07 MB  256     51.3%             102b6ecd-2081-4073-8172-bf818c35e27b  rack1
Field meaning
Datacenter The data center the information is from
status U for up or D for down
state (N)ormal, (L)eaving, (J)oining or (M)oving
address The node ip address
load The size on disk the scylla data takes
tokens The number of tokens per node
Owns Percentage of data owned by the node multiply by replication factor *
Host ID The host network ID
Rack The rack
  • Ownership information is meaningful when a keyspace is used
Clone this wiki locally