nodetool ring

Returns node status and information about the ring as determined by the node being queried.

Returns node status and information about the ring as determined by the node being queried. This information provides an idea of the load balance and if any nodes are down. If the cluster is not properly configured, different nodes may show a different ring. Ensure the node appears the same way in the ring. For virtual nodes (vnodes), use nodetool status for succinct output.

  • Address

    The URL of the node.

  • DC

    The datacenter containing the node.

  • Rack

    The rack or, in the case of Amazon EC2, the availability zone of the node.

  • Status - Up or Down

    Indicates whether the node is functioning or not.

  • State - Normal, Leaving, Joining, or Moving

    The state of the node in relation to the cluster.

  • Load

    The amount of file system data in the data directory, excluding the snapshots subdirectories. Because all SSTable data files are included, any data that is not cleaned up, such as TTL-expired cell or tombstoned data, is counted. Updates every 90 seconds.

  • Token

    The end of the token range up to and including the value listed. For an explanation of token ranges, see Data distribution overview.

  • Owns

    The percentage of the data owned by the node per datacenter times the replication factor. For example, a node can own 33% of the ring, but show 100% if the replication factor is 3.

  • Host ID

    The network ID of the node.

Synopsis

nodetool [connection_options] ring
[-r] [--] [keyspace]
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a valid option or user-defined value.
[ ] Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key:value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement; End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[ -- ] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

Definition

The short form and long form parameters are comma-separated.

-h, --host hostname
The hostname or IP address of a remote node or nodes. When omitted, the default is the local machine.
-p, --port jmx_port
The JMX port number.
-pw, --password jmxpassword
The JMX password for authenticating with secure JMX. If a password is not provided, you are prompted to enter one.
-pwf, --password-file jmx_password_filepath
The filepath to the file that stores JMX authentication credentials.
-u, --username jmx_username
The user name for authenticating with secure JMX.
--
Separates an option from an argument that could be mistaken for a option.
keyspace_name
The keyspace name.
-r, --resolve-ip
Node domain names instead of IPs.

Examples

Get cluster status on all keyspaces

nodetool ring

Results:

                
Datacenter: datacenter1
=======================
Address        Rack        Status State   Load            Owns                Token
                                                                              0
127.0.0.1      rack1       Up     Normal  119.67 KiB      100.00%             -9223372036854775808
127.0.0.2      rack1       Up     Normal  124.56 KiB      100.00%             0