mirror of
https://github.com/scylladb/scylladb.git
synced 2026-05-23 16:22:15 +00:00
55ecd92feb
If a node is dead and cannot be brought back, tablet migrations are stuck, until the node is explicitly marked as "permanently dead" / "ignored node" / "excluded" (name differs in different contexts). Currently, this is done during removenode and replace operations but it should be possible to only mark the node as dead, for the purpose of unblocking migrations or other topology operations, without doing the actual removenode, because full removal might be currently impossible, or not desirable due to lack of capacity or priorities. This patch introduces this kind of API: nodetool excludenode <host-id> [ ... <host-id> ] Having this kind of API is an improvement in user experience in several cases. For example, when we lose a rack, the only viable option for recovery is to run removenode with an extra --ignore-dead-nodes option. This removenode will fail in the tablet draining phase, as there is no live node in the rack to rebuild replicas in. This is confusing to the operator. But necessary before ALTER KEYSPACE can proceed in order to change replication options to drop the rack from RF. Having this API allows operators to have more unified procedures, where "nodetool excludenode" is always the first step of recovery, which unblocks further topology operations, both those which restore capacity, but also auto-scaling, tablet split/merge, load balancing, etc. Fixes #21281
150 lines
10 KiB
ReStructuredText
150 lines
10 KiB
ReStructuredText
|
|
========
|
|
Nodetool
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|
|
|
|
nodetool-commands/backup
|
|
nodetool-commands/cfhistograms
|
|
nodetool-commands/cfstats
|
|
nodetool-commands/checkandrepaircdcstreams
|
|
nodetool-commands/cleanup
|
|
nodetool-commands/clearsnapshot
|
|
nodetool-commands/cluster/index
|
|
nodetool-commands/compact
|
|
nodetool-commands/compactionhistory
|
|
nodetool-commands/compactionstats
|
|
nodetool-commands/decommission
|
|
nodetool-commands/describecluster
|
|
nodetool-commands/describering
|
|
nodetool-commands/disableautocompaction
|
|
nodetool-commands/disablebackup
|
|
nodetool-commands/disablebinary
|
|
nodetool-commands/disablegossip
|
|
nodetool-commands/drain
|
|
nodetool-commands/dropquarantinedsstables
|
|
nodetool-commands/enableautocompaction
|
|
nodetool-commands/enablebackup
|
|
nodetool-commands/enablebinary
|
|
nodetool-commands/enablegossip
|
|
nodetool-commands/excludenode
|
|
nodetool-commands/flush
|
|
nodetool-commands/getcompactionthroughput
|
|
nodetool-commands/getendpoints
|
|
nodetool-commands/getsstables
|
|
nodetool-commands/getstreamthroughput
|
|
nodetool-commands/gettraceprobability
|
|
nodetool-commands/gossipinfo
|
|
nodetool-commands/help
|
|
nodetool-commands/info
|
|
nodetool-commands/listsnapshots
|
|
nodetool-commands/proxyhistograms
|
|
nodetool-commands/rebuild
|
|
nodetool-commands/refresh
|
|
nodetool-commands/removenode
|
|
nodetool-commands/repair
|
|
nodetool-commands/resetlocalschema
|
|
nodetool-commands/restore
|
|
nodetool-commands/ring
|
|
nodetool-commands/scrub
|
|
nodetool-commands/setcompactionthroughput
|
|
nodetool-commands/setlogginglevel
|
|
nodetool-commands/setstreamthroughput
|
|
nodetool-commands/settraceprobability
|
|
nodetool-commands/snapshot
|
|
nodetool-commands/sstableinfo
|
|
nodetool-commands/status
|
|
nodetool-commands/statusbackup
|
|
nodetool-commands/statusbinary
|
|
nodetool-commands/statusgossip
|
|
Nodetool stop compaction <nodetool-commands/stop>
|
|
nodetool-commands/tablestats
|
|
nodetool-commands/tasks/index
|
|
nodetool-commands/toppartitions
|
|
nodetool-commands/upgradesstables
|
|
nodetool-commands/version
|
|
nodetool-commands/viewbuildstatus
|
|
|
|
The ``nodetool`` utility provides a simple command-line interface to the following exposed operations and attributes.
|
|
|
|
.. _nodetool-generic-options:
|
|
|
|
Nodetool generic options
|
|
========================
|
|
|
|
* ``-p <port>`` or ``--port <port>`` - The port of the REST API of the ScyllaDB node.
|
|
* ``--`` - Separates command-line options from the list of argument(useful when an argument might be mistaken for a command-line option).
|
|
|
|
Supported Nodetool operations
|
|
=============================
|
|
Operations that are not listed below are currently not available.
|
|
|
|
* :doc:`backup <nodetool-commands/backup/>` - Copy SSTables from a specified keyspace's snapshot to a designated bucket in object storage.
|
|
* :doc:`cfhistograms <nodetool-commands/cfhistograms/>` - Provides statistics about a table, including number of SSTables, read/write latency, partition size and column count.
|
|
* :doc:`cfstats </operating-scylla/nodetool-commands/cfstats/>` - Provides in-depth diagnostics regard table.
|
|
* :doc:`checkandrepaircdcstreams </operating-scylla/nodetool-commands/checkandrepaircdcstreams/>` - Checks and fixes CDC streams.
|
|
* :doc:`cleanup </operating-scylla/nodetool-commands/cleanup/>` - Triggers the immediate cleanup of keys no longer belonging to a node.
|
|
* :doc:`clearsnapshot </operating-scylla/nodetool-commands/clearsnapshot/>` - This command removes snapshots.
|
|
* :doc:`cluster <nodetool-commands/cluster/index>` - Run a cluster operation.
|
|
* :doc:`compact </operating-scylla/nodetool-commands/compact/>`- Force a (major) compaction on one or more column families.
|
|
* :doc:`compactionhistory </operating-scylla/nodetool-commands/compactionhistory/>` - Provides the history of compactions.
|
|
* :doc:`compactionstats </operating-scylla/nodetool-commands/compactionstats/>`- Print statistics on compactions.
|
|
* :doc:`decommission </operating-scylla/nodetool-commands/decommission/>` - Decommission the node.
|
|
* :doc:`describecluster </operating-scylla/nodetool-commands/describecluster/>` - Print the name, snitch, partitioner and schema version of a cluster.
|
|
* :doc:`describering </operating-scylla/nodetool-commands/describering/>` - :code:`<keyspace>`- Shows the partition ranges of a given keyspace.
|
|
* :doc:`disableautocompaction </operating-scylla/nodetool-commands/disableautocompaction/>` - Disable automatic compaction of a keyspace or table.
|
|
* :doc:`disablebackup </operating-scylla/nodetool-commands/disablebackup/>` - Disable incremental backup.
|
|
* :doc:`disablebinary </operating-scylla/nodetool-commands/disablebinary/>` - Disable native transport (binary protocol).
|
|
* :doc:`disablegossip </operating-scylla/nodetool-commands/disablegossip/>` - Disable gossip (effectively marking the node down).
|
|
* :doc:`drain </operating-scylla/nodetool-commands/drain/>` - Drain the node (stop accepting writes and flush all column families).
|
|
* :doc:`dropquarantinedsstables </operating-scylla/nodetool-commands/dropquarantinedsstables>` :code:`<keyspace>` :code:`<table>` Drop quarantined SSTables from the specified keyspace and table(s), or from all keyspaces if no keyspace is specified.
|
|
* :doc:`enableautocompaction </operating-scylla/nodetool-commands/enableautocompaction/>` - Enable automatic compaction of a keyspace or table.
|
|
* :doc:`enablebackup </operating-scylla/nodetool-commands/enablebackup/>` - Enable incremental backup.
|
|
* :doc:`enablebinary </operating-scylla/nodetool-commands/enablebinary/>` - Re-enable native transport (binary protocol).
|
|
* :doc:`enablegossip </operating-scylla/nodetool-commands/enablegossip/>` - Re-enable gossip.
|
|
* :doc:`excludenode </operating-scylla/nodetool-commands/excludenode/>`- Mark nodes as permanently down.
|
|
* :doc:`flush </operating-scylla/nodetool-commands/flush/>` - Flush one or more column families.
|
|
* :doc:`getcompactionthroughput </operating-scylla/nodetool-commands/getcompactionthroughput>` - Print the throughput cap for compaction in the system
|
|
* :doc:`getendpoints <nodetool-commands/getendpoints/>` :code:`<keyspace>` :code:`<table>` :code:`<key>`- Print the end points that owns the key.
|
|
* **getlogginglevels** - Get the runtime logging levels.
|
|
* :doc:`getsstables </operating-scylla/nodetool-commands/getsstables>` - Print the sstable filenames that own the key.
|
|
* :doc:`getstreamthroughput </operating-scylla/nodetool-commands/getstreamthroughput>` - Print the throughput cap for SSTables streaming in the system
|
|
* :doc:`gettraceprobability </operating-scylla/nodetool-commands/gettraceprobability>` - Displays the current trace probability value. 0 is disabled 1 is enabled.
|
|
* :doc:`gossipinfo </operating-scylla/nodetool-commands/gossipinfo/>` - Shows the gossip information for the cluster.
|
|
* :doc:`help </operating-scylla/nodetool-commands/help/>` - Display list of available nodetool commands.
|
|
* :doc:`info </operating-scylla/nodetool-commands/info/>` - Print node information
|
|
* :doc:`listsnapshots </operating-scylla/nodetool-commands/listsnapshots/>` - Lists all the snapshots along with the size on disk and true size.
|
|
* **move** :code:`<new token>`- Move node on the token ring to a new token
|
|
* **netstats** - Print network information on provided host (connecting node by default)
|
|
* :doc:`proxyhistograms </operating-scylla/nodetool-commands/proxyhistograms/>` - Print statistic histograms for network operations
|
|
* :doc:`rebuild </operating-scylla/nodetool-commands/rebuild/>` :code:`[<src-dc-name>]`- Rebuild data by streaming from other nodes
|
|
* :doc:`refresh </operating-scylla/nodetool-commands/refresh/>`- Load newly placed SSTables to the system without restart
|
|
* :doc:`removenode </operating-scylla/nodetool-commands/removenode/>`- Remove node with the provided ID
|
|
* :doc:`repair <nodetool-commands/repair/>` :code:`<keyspace>` :code:`<table>` - Repair one or more vnode tables.
|
|
* :doc:`resetlocalschema </operating-scylla/nodetool-commands/resetlocalschema/>` - Reset the node's local schema.
|
|
* :doc:`restore </operating-scylla/nodetool-commands/restore/>` - Load SSTables from a designated bucket in object store into a specified keyspace or table
|
|
* :doc:`ring <nodetool-commands/ring/>` - The nodetool ring command display the token ring information.
|
|
* :doc:`scrub </operating-scylla/nodetool-commands/scrub>` :code:`[-m mode] [--no-snapshot] <keyspace> [<table>...]` - Scrub the SSTable files in the specified keyspace or table(s)
|
|
* :doc:`setcompactionthroughput </operating-scylla/nodetool-commands/setcompactionthroughput>` - Set the throughput cap for compaction in the system
|
|
* :doc:`setlogginglevel</operating-scylla/nodetool-commands/setlogginglevel>` - sets the logging level threshold for ScyllaDB classes
|
|
* :doc:`setstreamthroughput </operating-scylla/nodetool-commands/setstreamthroughput>` - Set the throughput cap for SSTables streaming in the system
|
|
* :doc:`settraceprobability </operating-scylla/nodetool-commands/settraceprobability/>` ``<value>`` - Sets the probability for tracing a request. race probability value
|
|
* :doc:`snapshot </operating-scylla/nodetool-commands/snapshot>` :code:`[-t tag] [-cf column_family] <keyspace>` - Take a snapshot of specified keyspaces or a snapshot of the specified table.
|
|
* :doc:`sstableinfo </operating-scylla/nodetool-commands/sstableinfo>` - Get information about sstables per keyspace/table.
|
|
* :doc:`status </operating-scylla/nodetool-commands/status/>` - Print cluster information.
|
|
* :doc:`statusbackup </operating-scylla/nodetool-commands/statusbackup/>` - Status of incremental backup.
|
|
* :doc:`statusbinary </operating-scylla/nodetool-commands/statusbinary/>` - Status of native transport (binary protocol).
|
|
* :doc:`statusgossip </operating-scylla/nodetool-commands/statusgossip/>` - Status of gossip.
|
|
* :doc:`stop </operating-scylla/nodetool-commands/stop/>` - Stop compaction operation.
|
|
* **tablehistograms** see :doc:`cfhistograms <nodetool-commands/cfhistograms/>`
|
|
* :doc:`tablestats </operating-scylla/nodetool-commands/tablestats/>` - Provides in-depth diagnostics regard table.
|
|
* :doc:`tasks </operating-scylla/nodetool-commands/tasks/index>` - Manage tasks manager tasks.
|
|
* :doc:`toppartitions </operating-scylla/nodetool-commands/toppartitions/>` - Samples cluster writes and reads and reports the most active partitions in a specified table and time frame.
|
|
* :doc:`upgradesstables </operating-scylla/nodetool-commands/upgradesstables>` - Upgrades each table that is not running the latest ScyllaDB version, by rewriting SSTables.
|
|
* :doc:`version </operating-scylla/nodetool-commands/version>` - Print the DB version.
|
|
* :doc:`viewbuildstatus </operating-scylla/nodetool-commands/viewbuildstatus/>` - Shows the progress of a materialized view build.
|
|
|